Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.17 KB
Raw

Contributing

Thanks for considering contributing to project.

Opening issues

If you find a bug, please feel free to open an issue.

If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Fixing bugs

  1. Fork this repository and then clone it locally.

  2. Create a topic branch for your changes:

git checkout -b fix/fix-for-that-thing
  1. Commit a failing test for the bug:
git commit -am "fix: adds a failing test to demonstrate that thing"
  1. Commit a fix that makes the test pass:
git commit -am "fix: adds a fix for that thing!"
  1. If everything looks good, push to your fork:
git push origin fix/fix-for-that-thing
  1. Submit a pull request.

Adding new features

Thinking of adding a new feature? Cool! Open an issue and let’s design it together.