Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.36 KB

How to contribute

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target other branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git branch my_topic_branch master then checkout the new branch with git checkout my_topic_branch. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Make sure your code conforms to the styleguide.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
    One sentence summary.

    Detailed description of the commit ...
    ....
  • TODO: Test your changes

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the main repository.

Additional Resources