Thanks for your interest in contributing to Gubernator! Please take a moment to review this document before submitting a pull request.
Please ask first before starting work on any significant new features.
We love to code, and as such, we tend to code first and talk later. (wut? I haz to talk with people?) However, it's never a fun experience to have your pull request declined after investing joy, time and effort into a new feature.
To avoid this from happening to you, we request that contributors create a GitHub issue and tag a maintainer, so we can first discuss any new feature ideas. Your ideas and suggestions are welcome!
Bug requests are always welcome, but if the bug request requires a large refactor to fix, you might want to create and issue and discuss.
If this is something you think you can fix, then fork https://github.com/gubernator-io/gubernator and create a branch with a descriptive name.
You can run the test suite with all the bells and whistles by running
$ make testWe use a linter to ensure things stay pretty, ensure your code passes the linter by running
$ make lintWe don't have a specific structure for commit messages, but please be as descriptive as possible and avoid lots of tiny commits. If this is your style, please squash before making a PR, or we may squash on merge.
At this point, your changes look good, and tests are passing, you are ready to create a pull request. Please explain WHY the PR exists in the description, and link to any related PR's or Issues.
A PR can only be merged into master by a maintainer if: CI is passing, approved by another maintainer and is up-to-date with the default branch. Any maintainer is allowed to merge a PR if all of these conditions ae met.
See RELEASE.md for detailed procedures