We welcome contributions from the community, Top Hatters and non-Top Hatters alike. Here are some guidelines to help you get started!
Basic development flow
- Ensure the problem you are solving is an issue or you've created one
- Clone the repo
- We use make.
make helpwill show you a list of development commands
make install-watchwill install yvm on your shell, update when you make changes, and automatically source yvm.sh. Make sure to only run this in the root yvm directory. It will fail elsewhere.
make lintare also commonly helpful
Make sure all changes are well documented. Our documentation can be found inside the
docs section of this repo. Be sure to read it carefully and make modifications wherever necessary.
You can also access the documentation on our website
Please make sure to look over our Code of Conduct as well!
Manual testing command contributions
make install yvm <your-command-here>