-
Notifications
You must be signed in to change notification settings - Fork 908
Contribute to Kedro
If you would like to help improve Kedro, here are some ways to contribute.
Activity | Description |
---|---|
Community Q&A | We encourage you to ask and answer technical questions on Slack. |
Report bugs and security vulnerabilities | We use GitHub issues to keep track of known bugs and security vulnerabilities. We keep a close eye on them and update them when we have an internal fix in progress. Before you report a new issue, do your best to ensure your problem hasn't already been reported. If it has, just leave a comment on the existing issue, rather than create a new one. If you have already checked the existing GitHub issues and are still convinced that you have found odd or erroneous behaviour then please file a new one. |
Propose a new feature | If you have new ideas for Kedro functionality then please open a GitHub issue and describe the feature you would like to see, why you need it, and how it should work. |
Review pull requests | Check the Kedro repo to find open pull requests and contribute a review! |
Contribute a fix or feature | If you're interested in contributing fixes to code or documentation, first read our guidelines for contributing developers for an explanation of how to get set up and the process you'll follow. Once you are ready to contribute, a good place to start is to take a look at the good first issues and help wanted issues on GitHub. |
Contribute to the documentation | You can help us improve the Kedro documentation online. Send us feedback as a GitHub issue or start a documentation discussion on GitHub. You are also welcome to raise a PR with a bug fix or addition to the documentation. First read the guide Contribute to the Kedro documentation. |
Contribute changes to Kedro that are tested on Databricks | Many Kedro users deploy their projects to Databricks, a cloud-based platform for data engineering and data science. If you'd like to extend and improve the experience for Kedro users on Databricks, visit the Contribute changes to Kedro that are tested on Databricks wiki page to learn how to deploy and test your changes. |
Dataset contributions to the Kedro-Datasets plugin are the most frequently accepted, since they do not require any changes to the framework itself.
However, we do not discourage contributions to any of the other Kedro-Plugins or the framework or Kedro-Viz
. As a guide, contributions based on existing issues from the Kedro team, or issues that the team has deemed useful, are most likely to be accepted. Any contributions that affect fundamental changes to the Kedro Framework would require discussion first. In this case, we recommend opening an issue instead of a pull request.
You can also make a contribution to awesome-kedro
, our curated list of community content through a PR.
The documentation about Kedro's Technical Steering Committee describes the detail of how Kedro is maintained, and the team behind the project.
We also want to thank all the open-source contributors whose work goes into Kedro releases.
If you're an academic, Kedro can also help you, for example, as a tool to solve the problem of reproducible research. Use the "Cite this repository" button on our repository to generate a citation from the CITATION.cff file.
- Contribute to Kedro
- Guidelines for contributing developers
- Contribute changes to Kedro that are tested on Databricks
- Backwards compatibility and breaking changes
- Contribute to the Kedro documentation
- Kedro documentation style guide
- Creating developer documentation
- Kedro new project creation - how it works
- The CI Setup: GitHub Actions
- The Performance Test Setup: Airspeed Velocity
- Kedro Framework team norms & ways of working ⭐️
- Kedro Framework Pull Request and Review team norms ✍️