Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Latest commit

 

History

History
30 lines (24 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.76 KB
Raw

How to contribute

We happily welcome contributions from the community! Please follow this guide when logging issues or making code changes.

Help Wanted

If you are interested in contributing but don't know where to start, check out the "help wanted" issues for ideas.

Logging Issues / Feature Requests

All issues or feature requests should be created using GitHub Issues. 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.

Lastly, please indicate if your issue is a feature request or bug.

Making Changes

Code or documentation changes are welcome and should follow the guidelines below.

  • Fork this repository and create a new branch for your changes
  • Make your changes and don't be afraid to ask questions!
  • If making code changes, don't forget to add tests and lint your new code following the JS Standard code style
    • Run npm run lint to lint your code
    • Run npm test to execute tests and report code coverage
    • Yes, we require 100% code coverage for all Pull Requests
  • Once finished, submit a Pull Request for your changes
    • All Pull Requests should be made to the master branch
    • Make sure your branch is up to date with the upstream repository (if not, perform a downstream merge and resolve any merge conflicts)