Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.22 KB

CONTRIBUTING

This document outlines how to contribute to jsfmt. New contributors are always welcome.

SOURCES

Based on http://www.contribution-guide.org/ and the node.js CONTRIBUTING.md.

These are great documents to get more details about how to contribute.

BUGS

  • Check if the issue has already been filed here: jsfmt issues
  • If an issue already exists let us know if you're also experiencing the same issue and any additional details you can provide.
  • If its a new issue, please file a new issue with as much detail as possible including steps to reproduce the problem.

CONTRIBUTING CHANGES

  1. Hit 'fork' on Github, creating e.g. /jsfmt.
  2. git clone [email protected]:<username>/jsfmt
  3. cd jsfmt
  4. git checkout -b <branch_name>
  5. Write new tests expecting the correct functionality and make sure they fail.
  6. Fix the issue until the tests pass.
  7. git commit -m "<message>" # where <message> is a detailed description of the changes
  8. git push origin <branch_name>
  9. Visit your fork on Github and click "Pull request" including the issue number in the description field and hit "Submit"