Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.13 KB

Contributing Guildlines

Setup

  1. Fork the project and clone the fork to your machine.
  2. Create a feature branch to work in. $ git checkout -b name-of-feature

Writing Code

  • Use the project's coding style, not your own. If the code you write looks drastically different than the preexisting code, you're doing it wrong.
  • Include tests that fail without your code, and pass with it.
  • If you add a new feature or break backwards compatibility, update the project's documentation accordingly.
  • Commits should have meaningful messages. If you end up with a bunch of commits with garbage messages, squash your commits before submitting a pull request.

Pull Requests

  1. Push your feature branch to your remote repo on GitHub. $ git push origin name-of-feature
  2. Create a pull request against the *-wip branch if present, otherwise master.
  3. Write a meaningful title and description.
  4. Submit the pull request!