Contributions are always welcome. Please read the code of conduct before you begin.
Discussions are for general questions and open-ended discourse related to this project. Before starting a discussion, please check the support resources to make sure this is the best place to get an answer or receive feedback. Consider submitting an issue if you have a specific topic you'd like to discuss.
Issues are for discussing specific topics, organizing them with labels, assigning them to a contributor, and grouping them into projects and milestones to help drive development. Before submitting an issue, please search existing issues to see if someone has already submitted your issue. This doesn't always work, and it's ok to submit a duplicate issue, but a quick search could save everyone some time.
If you believe submitting your issue publicly presents a security risk, please read the security policy for information on how to report security issues.
If something doesn't seem to be working right with this project, submit a bug report. The bug report template will help you provide the information required to assess the bug. Fill out each section of the template as best you can; the more information you can provide, the better the chance of having the bug addressed.
If you have an idea to enhance this project, submit a feature request. The feature request template will help you provide the information required to asses your idea. Fill out each section of the template as best you can; the more information you can provide, the better the chance of having your idea addressed.
Pull requests are the primary change mechanism for this project. If you'd like to contribute a change, first select or submit an issue to work on. Having an issue associated with your pull request helps document the reason for the request, keep changes focused, and improve your chance of merging.
Start by forking this repository, creating a branch, and making some
changes. Branch names should be descriptive, use - separators, and may
optionally include an issue ID prefix (e.g. 42-making-changes). Node.js
and npm-scripts provide the tools required to maintain a consistent coding
style and automate essential development tasks. Install the project dependencies
with npm install, then use npm run to see a list of available tasks.
Changes must adhere to this project's coding and documentation standards. All
lint tasks should run without generating errors or warnings. Add tests to an
appropriate suite in /test to cover your changes, then use npm test to make
sure all tests pass.
Add yourself to the list of contributors, optionally linked to your personal site or a social profile, if you'd like recognition for your contributions. List notable changes in the Unreleased section of the changelog.
When you're ready, create a pull request against the main branch with a
good commit message. The pull request template will help you provide the
information required to review your request. Fill out each section of the
template as best you can; the more information you can provide, the better the
chance of having your changes merged.
Always use rebase to bring the latest changes from main to your branch before
submitting your request. Squash commits into logical units of work; when in
doubt, squash to a single commit.
Direct financial support from the community is always a great way to contribute to this project; it provides essential monetary support and encourages ongoing development.