Welcome to nimble_charts! Nimblesite is excited that you're interested in contributing to this project. This is a community-maintained fork of the original charts_flutter library, which is no longer maintained by Google.
This is a continuation of the charts_flutter project. We aim to keep this charting library up-to-date and create the most stable for of the original. There are already a lot of widget tests, and we will continue to add widget and integration tests until there is very high test coverage.
We welcome contributions of all kinds, from bug fixes to new features. Here are some ways you can help:
-
Reporting Issues: If you find a bug or have a suggestion, please open an issue on our GitHub repository.
-
Submitting Pull Requests: Feel free to submit pull requests for any improvements you'd like to make.
-
Improving Documentation: Help us keep our documentation clear, up-to-date, and comprehensive.
-
Sharing Ideas: We're always open to new ideas for features or improvements. Share these in the Discussions section of our GitHub repository.
- Fork the repository
- Clone your fork:
git clone https://github.com/YourUsername/nimble_charts.git - Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name - Make your changes
- Push to your fork and submit a pull request
Please follow the existing code style in the project. You need to abide by the rules of the austerity package.
Ensure that your contributions include appropriate tests and that all existing tests pass.
Unit tests are not enough. All UI changes require widget tests, and even better if those widget tests double as integration tests.
It's usually a good idea to capture at least one golden of the charts, and there are plenty of examples of that in the existing tests.
Join our community discussions on GitHub Discussions to share ideas, ask questions, or get help.
Thank you for contributing to nimble_charts and helping to keep this valuable resource alive for the Flutter community!