When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
If you are working on an open issue, please be sure to test the code to the best of your ability. While test cases are not required as part of contributing, they are always helpful.
Please note this project's simple code of conduct, please follow it in all your interactions.
Also note that not every pull request or issue can always be addressed. The project maintainers reserve the right to ignore, close, or move any issue or pull request. Especially if requests are not in line with the goals of the tool and its authors. That said, feedback and suggestions are vital to any open-source project and are always appreciated.
The simple reality of it is that we all have jobs and can't always be super responsive. Please do not take anything personally.
- Be sure to sign the CLA
- Ensure any code is accompanied by a test case should it make sense.
- Ensure your contribution does not break any existing test cases.
- If it makes sense, update the README.md with details of changes should there be a breaking change to the brief documentation within it or if new information makes sense.
- Increase the version number in
version/version.go. The versioning scheme we use is SemVer. - You may merge the Pull Request in once you have the sign-off of another developer, or if you do not have permission to do that, you may request someone to merge it for you.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers support a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Be excellent to each other. It's not that hard folks.
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.