Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

21 lines (14 loc) · 2.34 KB
Raw

Contributing to Gort

Thank you for your interest in contributing to Gort. We are grateful for contributions of all kinds; reporting issues, updating documentation, fixing bugs, implementing new features, and any other type of contribution is hugely beneficial to Gort and our community. We're excited to see what you come up with!

Before submitting your contribution, please review the following guidelines. These are intended to make the contribution process as simple and predictable as possible for both contributors and project maintainers.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Workflow

  1. Fork the project repository and create a topic branch in your fork for your work. This fork should almost always be made against the develop branch of the project you're working on, unless you have previously discussed basing your changes on a different branch with the team.
  2. This project uses pre-commit to ensure certain consistency of certain stylistic elements. Install pre-commit, and run pre-commit install to set up the git hook scripts.
  3. Make your changes, including any necessary tests to cover new features or fixes that you make.
  4. Ensure that all tests pass.
  5. Submit a Pull Request against the develop branch of the project you're working on.
  6. The project committers review pull requests regularly and will work with contributors to provide feedback and guidance around any changes that are required before the pull request can be accepted.
  7. You may merge the Pull Request once your change is accepted. If you do not have permission to do that, you may request the reviewer to merge it for you.

Code of Conduct

All project contributors are required to behave in accordance with our Code of Conduct, which is adapted from the Contributor Covenant. Please report any behavior that violates the code of conduct to [email protected] or to Matt Titmus or Tom Elliott on the Gort Slack Community so that we can investigate and take appropriate action.