Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 931 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 931 Bytes

Follow this flow to fix bugs, implement new features for Punch:

  1. Fork Punch on GitHub:

  2. Clone the forked repository:

    git clone [email protected]:YOUR_USER/punch.git && cd punch

  3. Verify existing tests pass:

    jasmine-node spec

  4. Create a topic branch:

    git checkout -b feature

  5. Read the Code Style Guide.

  6. Make your changes. (It helps a lot if you write tests first.)

  7. Verify that tests still pass:

    jasmine-node spec

  8. Run JSHint and make sure you're code didn't bring in any inconsistencies:

     `jshint lib/*`

  9. Push to your fork:

    git push -u YOUR_USER feature

  10. Send a pull request describing your changes.

  11. If possible, make sure Punch Guide is up to date, after your changes were merged.