Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.46 KB

How to contribute

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually a branch named feature/foo-bar-baz or bug/foo-bar-baz.
  • Before submitting your change, squash all your commits.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
    (Verb) Summary in under 55 characters
    (blank line)
    Describe this change in as many lines as you like,
    each line under 55 characters (!) in width.
  • If the repository has tests, make sure you have added the necessary tests for your changes, and run all the tests to assure nothing else was accidentally broken.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the parent repository.
    • Pull requests with blank titles and summaries will not be accepted.

Additional Resources