Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.02 KB

Contributing

Thanks for considering contributing to Pile!

Opening issues

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

Fixing bugs

Here’s a quick guide:

  1. Fork this repository and then clone it locally:
git clone https://github.com/udarajay/pile
  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.

Adding new features

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