Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 826 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 826 Bytes

How to contribute

The best way to make sure your issue is addressed is to submit a patch. Patches are accepted through pull requests, and email.

However, before sending a patch, please make sure that the following applies:

  • Your commit message links to that issue.
  • Your commit message is descriptive enough.
  • Your patch doesn't have useless merge commits.
  • Your coding style is similar to the project.
  • You follow the branching model below (it's simple, you'll see).
  • You understand that we're super grateful for your patch :)

Branches

The project use a fairly simple model of branches:

  • master is the "trunk" version. By definition this branch can be broken. This is from where people want to hack.
  • Check the last recent tags for a stable version

Topic branches should be used as much as possible.