-
Notifications
You must be signed in to change notification settings - Fork 18
Contributing
Eivind Arvesen edited this page Oct 18, 2015
·
4 revisions
Contributions in the form of code (e.g. implementing new features, bug-fixes) should follow the "fork-and-pull" workflow:
- Fork the repo on Github
- Create a branch
- Clone it to your computer
- Make and commit your changes
- Sync (fetch and merge) with "upstream"
- Push your changes to your branch on Github
- Open a pull request "upstream" with your changes
Pull requests should explain clearly what changes have been made, and why they have been made. They should also reference any relevant issues.
Pull requests that do not pass the CI tests will not be merged.
Any pull request containing new functionality should also implement new tests accordingly, using Bats. The project tests can be found in the ./tests directory.
If you have Bats installed, you can run all tests (for both bash and zsh) locally by issuing bash tests/run-tests.sh in the root project folder of prm.