Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.8 KB

Contributing

We welcome all forms of contribution! Feedback, bug reports and feature requests can be just as valuable as code contributions!

If you want to make code contributions, please follow the process outlined below. Whether you have a specific fix or feature in mind already, or if you have spare time and just want to help out - we'd love to hear from you!

Code contributions

Process

To avoid wasted effort, please always follow this process:

  1. Reach out to the Gravity maintainers to discuss what you want to do.
    • This helps avoid duplicate work - someone else might already be working on the same thing you were going to do!
    • The maintainers can also help you determine how best to architect your contribution
  2. Create a feature branch
  3. Write your code
    • Make sure you follow all the relevant conventions (see next section)
  4. Create a pull request once your code is ready
    • The maintainers will then review your code and, if necessary, request changes
    • Once approved, your PR will be merged and the associated feature branch will be deleted.

Code conventions and other important info

Before diving into the code, please familiarise yourself with the following:

Any code contributions that do not follow these conventions is likely to be rejected!