Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 922 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 922 Bytes

How to contribute

Making and submitting changes

To contribute to this project, follow these steps:

  1. Fork this repository.
  2. Make sure there is an existing issue or create one.
  3. Create a new branch: git checkout -b <prefix>/<branch-name>.
    1. The prefix is either feature or bugfix.
    2. The branch name is the issue number followed by a short description. E.g. feature/42-implement-search.
  4. Make your changes.
  5. Commit your changes: git commit -m '<commit-message>'.
  6. Push to the original branch: git push origin <project-name>/<location>.
  7. Create a pull request with a descriptive title.
  8. Link the issue in the pull request description.

Make sure your pull request is a small, focused change. Don't try to fix multiple issues in one pull request. However, some boyscouting is allowed.

Getting started

See the README.md for information on how to run this project locally.