Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.23 KB

How to contribute

If you're finding and issue with this add-on I'd love to include a fix for it so it continues to work.
I can't keep up with all the platforms and testing necessary so your contributions are really helpful.

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • Start from the master branch
    • Create the branch git branch my_contribution master
    • Then checkout the new branch with git checkout my_contribution.
    • Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Include a reasonable commit message describing the change
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.
    • Run all tests with cfx test

Submitting Changes

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