Skip to content
This repository has been archived by the owner on Jul 30, 2021. It is now read-only.

Latest commit

 

History

History
43 lines (31 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.95 KB

How to Contribute

We'd love to accept your patches and contributions to this project. Pull requests are part of what makes open source great. There are just a few small guidelines you need to follow.

Code of Conduct

Participation in this project comes under the Contributor Covenant Code of Conduct

Submitting code via Pull Requests

  • We follow the Github Pull Request Model for all contributions.
  • For large bodies of work, we recommend creating an issue outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
  • All submissions, will require review before being merged.
  • Finally - Thanks for considering submitting code to the project!

Formatting

When submitting pull requests, make sure to do the following:

  • Maintain the same code style as the rest of the project.
  • Remove trailing whitespace. Many editors will do this automatically.
  • Ensure any new files have a trailing newline

How to speed the merging of pull requests

  • Describe your changes in the CHANGELOG.md (if present).
  • Give yourself some credit in the appropriate place (usually the CHANGELOG.md).
  • Make commits of logical units.
  • Ensure your commit messages help others understand what you are doing and why.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Maintain the same code style.
  • Maintain the same level of test coverage or improve it.

Additional Resources