Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.32 KB

CONTRIBUTING.rst

File metadata and controls

19 lines (14 loc) · 1.32 KB
Raw

Contributing

While Ergonomica aims to, by being open source, be a project for and maintained by the community, there are a few rules that should be generally followed. This file outlines those guidelines as well as how the GitHub contribution process works.

Pull Request Process

If you are confused about how to do the following tasks, they're written up much more nicely in GitHub's documentation; I suggest you search that.

  1. Create a fork of ergonomica/ergonomica, typically under your account.
  2. Make your desired changes.
  3. Add unit tests in the tests directory for testing changes. This both helps ensure your new code is stable and makes you, in the process of writing tests, consider how you want the feature to work.
  4. Create a pull request detailing what is changed and why this change is necessary/improves users' experience. Additionally, include some documentation on how to use this command.
  5. This pull request will be automatically tested against the Ergonomica CI (including your additional tests). If it doesn't pass, revise your changes until it does.
  6. If approved, your pull request will be merged into master!

These steps are just an outline of the process; feel free to submit unfinished pull requests and we'll help with the rest!