Home Explore Help
Sign In
candlewaster
/
wick
Watch 3
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 692f5a7cc9
Branches Tags
wick
/
CONTRIBUTING.md

CONTRIBUTING.md 1.3 KB
History Raw

Contributing

Thanks for taking the time to help make harp better. Here are some guidelines that will highly increase the chances of your fix or feature request from being accepted.

Bug Fixes

If you find a bug you would like fixed. Open up a ticket with a detailed description of the bug and the expected behaviour. If you would like to fix the problem yourself please do the following steps.

  1. Fork it.
  2. Create a branch (git checkout -b fix-for-that-thing)
  3. Commit a failing test (git commit -am "adds a failing test to demonstrate that thing")
  4. Commit a fix that makes the test pass (git commit -am "fixes that thing")
  5. Push to the branch (git push origin fix-for-that-thing)
  6. Open a Pull Request

Please keep your branch up to date by rebasing upstream changes from master.

New Functionality

If you wish to add new functionality to harp, please provide @sintaxi and @kennethormandy a harp application that demonstrates deficiency in current design or desired additional behaviour. Its best if you explaining the problem you are trying to solve, not just the solution you want. You may also submit a pull request with the steps above.