Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

31 lines (17 loc) · 1.33 KB
Raw

Contributing

First off, thank you for considering contributing to this project. It's people like you that make open source possible.

1. Where do I go from here?

If you've noticed a bug or have a feature request, make sure to check our issues if there's something similar to what you have in mind. If there isn't, you can open a new issue and provide as much detail as possible about what you'd like to see or what problem you're experiencing.

2. Fork & create a branch

If this is something you think you can fix, then fork the repository and create a branch with a descriptive name.

3. Get the code

The project uses the following tools and libraries. Make sure to familiarize yourself with them before starting to code.

  • Tool/Library 1
  • Tool/Library 2
  • etc.

4. Make the change

Once you've got the code and are ready to make your change, make sure to add tests for your change. This helps us ensure that the change works as expected and prevents future regressions.

5. Make a Pull Request

At this point, you should switch back to your forked copy of the repository, and create a new pull request. The PR should provide a succinct description of the changes.

License

By contributing your code, you agree to license your contribution under the terms of the MIT license.