# Contributing Guidelines

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](https://github.com/decanTyme/chartjs-plugin-tailwindcss-colors/issues) 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](https://github.com/decanTyme/chartjs-plugin-tailwindcss-colors/discussions) page.

## Reporting bugs

Well structured, detailed bug reports are highly valuable for the project.

Guidelines for reporting bugs:

- Check the [issues](https://github.com/decanTyme/chartjs-plugin-tailwindcss-colors/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](http://jsbin.com) or similar

If there's any other details that may be related to the bug, it is encouraged to also include it.

## Local development

Run `pnpm install` to install all the libraries, then run `pnpm dev` to build and run tests as you make changes.

## Pull requests

Clear, concise pull requests are excellent at continuing the project's community driven growth. But please review [these guidelines](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) 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 [`/src`](https://github.com/decanTyme/chartjs-plugin-tailwindcss-colors/tree/main/src) and [`/src/__tests__`](https://github.com/decanTyme/chartjs-plugin-tailwindcss-colors/tree/main/src/__tests__)
- If adding new functionality, please also include any relevant changes to the documentation
- Please make sure to run `pnpm stylecheck` before submitting a PR
- Please make sure your commits follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification

> **NOTE**: This repo adheres to [Semantic Versioning (SemVer)](https://semver.org/).

## License

By contributing your code, you agree to license your contribution under the [MIT license](LICENSE).