Skip to content

Guidelines for Contributing

Mitch Talmadge edited this page Oct 2, 2017 · 1 revision

Want to help this library grow? I'd love your help. Please follow these guidelines when contributing:

  • This repository closely follows the git-flow workflow. Please brush up on this, as Pull Requests which do not follow the workflow may be rejected. Not to mention, git-flow is popular and will benefit you in other projects as well. :)
  • Please open an issue first, or comment on an existing issue. Don't just start coding without letting me know and expect me to accept it.

New Features

When working on a feature, please create your own branch from the develop branch, NOT master. Prefix the branch name with feature/. Whatever comes after is up to you. Example: feature/new-graph.

Bug Fixes

Simple bug fixes can be committed to the develop branch without the need for a new branch.

Hotfixes, which are meant to quickly patch a broken release, should branch off of master, NOT develop. Similarly to feature branches, prefix the branch name with hotfix/.