Contributing to Recharts#
We'd love for you to contribute to our source code and to make Recharts even better than it is today! Here are the guidelines we'd like you to follow:
Issues and Bugs#
Where to Find Known Issues#
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.
Reporting New Issues#
The best way to get your bug fixed is to provide a reduced test case. jsFiddle provide a way to give live examples. You can fork our example in recharts.org to show your case.
Pull Requests#
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
Before submitting a pull request, please make sure the following is done…
Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Fork the repo and create your branch from
master.If you've added code that should be tested, add tests!
If you've changed APIs, update the documentation and demo.
Ensure the test suite passes (
npm run test).Make sure your code lints (
npm run lint) - we've done our best to make sure these rules match our internal linting guidelines.
Code Guide#
Our linter will catch most styling issues that may exist in your code.
You can check the status of your code styling by simply running: npm run lint
However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb's Style Guide will guide you in the right direction.
Code Conventions#
- Use semicolons
; - Commas last
, - 2 spaces for indentation (no tabs)
- Prefer
'over" - 100 character line length
- Write "attractive" code
License#
By contributing to Recharts, you agree that your contributions will be licensed under its MIT license.