Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.64 KB

How to contribute

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub

Making Changes

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

ISSUE-1234: terse and to the point message describing change

  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.
  • Make sure you've done a squash and rebase before submitting

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request.
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Additional Resources