Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 2.7 KB
Raw

Contributing to 'Local Sheriff'

Thank you for taking the time to contribute! We are excited to welcome contributors and we really value the time you take to work with us on this project.

This documents is a set of guidelines for contributing to 'Local Sheriff' on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.

What we're working on

The project is still at an early stage, which means there are a lot of opportunities to contribute in a meaningful way. To ease the onboarding process, issues will be gathered and created issues in the issue tracker. Please take a look at the opened issues.

How to submit changes

Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository!

  1. Notify others by commenting on the issue. By commenting on the issue, you will initiate a discussion around possible solutions and also communicate to other contributors that you started working on it. This will avoid having several people starting working on the same thing.
  2. Fork this repository. This makes your own version of this project you can edit and use.
  3. Make your changes! You can do this in the GitHub interface on your own local machine (we strongly recommend that you create a new branch to make your changes). Once you're happy with your changes...
  4. Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.

First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.

How to report bugs

Bugs are everywhere, and we would love it if you could be on the lookout for them, and raise an issue if you find one. Bugs can be anywhere:

  • Conceptual design,
  • Code,
  • Spelling or formatting,
  • or anything else we haven't yet thought of.

If you notice a bug, please raise an issue and label it with the label bug. Then anyone in community can get right on it, and everything gets fixed faster.