Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.53 KB

Contributing

Hey! Thanks for your interest in contributing to this project.

In lieu of formal rules, please familiarise yourself with the following guidelines:

Also note, this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

In brief, for issues:

  • before opening an issue, please search for existing issues
  • if you're reporting a bug, please include steps to reproduce the issue and a reduced test case
  • for feature requests, please share the motivation for the feature and how you would implement it

For pull requests:

  • please make use of the included linting and editor configuration
  • add a unit test for new/changed functionality
  • format commit messages according to Conventional Commits
  • When creating a new rule, please add it to index.js, document it (see docs) and update the configuration table

If in doubt, file an issue first.

Thanks!