Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 1.11 KB
Raw

How to contribute

We welcome contributions from the community and are pleased to have them. Please follow this guide when logging issues or making code changes.

Logging Issues

All issues should be created using the new issue form. Clearly describe the issue including steps to reproduce if there are any. Also, make sure to indicate the earliest version that has the issue being reported.

Patching Code

Code changes are welcome and should follow the guidelines below.

  • Fork the repository on GitHub.
  • Add tests for your new code ensuring that you have 100% code coverage (we can help you reach 100% but will not merge without it).
    • Run npm test to generate a report of the test coverage
  • Pull requests should be made to the main branch.

To help encourage consistent code style guidelines, we have included an .editorconfig file for use with your favorite editor.

Read more about EditorConfig here.