Contributions to Chart.js are welcome and encouraged, but please have a look through the guidelines in 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 annotation plugin, please take a look at the GitHub Discussions page.
Well structured, detailed bug reports are hugely valuable for the project.
Guidlines for reporting bugs:
- Check the issue search 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
Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.
Run npm ci to install all the libraries, then run npm run 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 and the guidelines below 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 make changes to the files in
/src - Please add tests in
/test - Spaces for indentation, not tabs please
- If adding new functionality, please also update the relevant
.mdfile in/docs - Please make your commits in logical sections with clear commit messages
By contributing your code, you agree to license your contribution under the MIT license.