Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 1.5 KB

Contributing

Thanks for considering contributing to Default!

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

We love pull requests. Here’s a quick guide:

  1. Fork this repository and then clone it locally:
git clone https://github.com/ferruslogic/default
  1. Create a topic branch for your changes:
git checkout -b fix-for-that-thing
  1. Commit a failing test for the bug:
git commit -am "Adds a failing test to demonstrate that thing"
  1. Commit a fix that makes the test pass:
git commit -am "Adds a fix for that thing!"
  1. Run the tests:
npm test
  1. If everything looks good, push to your fork:
git push origin fix-for-that-thing
  1. Submit a pull request.

  2. Enjoy being the wonderful person you are

After you’ve opened your pull request, you should email me your mailing address so I can mail you a personal thank you note. Seriously!

Adding new features

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