Any manner of meaningful contributions to chartjs-plugin-tailwindcss-colors are welcome, encouraged, and highly appreciated, but please take a look through the guidelines within this document before raising an issue or writing code for the project.
The issue tracker is the preferred channel for reporting bugs, requesting new features, and submitting pull requests. Please do not use issues for support requests. For help using the plugin, please take a look at the GitHub Discussions page.
Well structured, detailed bug reports are highly valuable for the project.
Guidelines for reporting bugs:
- Check the issues to see if it has already been reported
- Isolate the problem to a simple test case
- Provide a demonstration of the problem on JS Bin or similar
If there's any other details that may be related to the bug, it is encouraged to also include it.
Run yarn to install all the libraries, then run yarn dev to build and run tests as you make changes.
Clear, concise pull requests are excellent at continuing the project's community driven growth. But please review these guidelines as well as the following guidelines before starting work on the project.
Guidelines:
- Please create an issue first:
- For bugs, we can discuss the fixing approach
- For enhancements, we can discuss if it is within the project scope and avoid duplicate effort
- Please only make changes to the files in
/srcand/src/__tests__ - If adding new functionality, please also include any relevant changes to the documentation
- Please make sure to run
yarn stylecheckbefore submitting a PR - Please make sure your commits follow the Conventional Commits specification
NOTE: This repo adheres to Semantic Versioning (SemVer).
By contributing your code, you agree to license your contribution under the MIT license.