We ❤️ all contributions, big and small!
When creating a PR for a UI feature or a feature task/subtask with UI impact, run the PR build in
Docker with sample data and include a GitHub-hosted screen recording in its description. Show the
feature and its result, and include the recorded commit, startup/health checks and sample-data
setup. Screenshots supplement
the video; they do not replace it. Follow UI PR recording, or
invoke /ui-pr-recording. Keep the PR draft if setup, recording or upload is blocked. Standalone
fixes, refactors, styling, localization, docs, tests and backend-only changes may explain N/A.
This step belongs to PR creation; it is not required for every implementation task or standalone
review. Automated tests are still required where applicable.
Read Build Code and Run Tests for how to setup your local development environment. Get started with our Good first issues.
For Python work in this checkout, use the locked local Python environment guide.
It documents the profiles, their Make commands, the Nox sessions and their bootstrap,
and how application synchronization affects an existing env/. make install_dev_env
prepares the full test profile; formatting and generation use separate tool environments.
We also recommend joining the OpenMetadata Slack Workspace to meet the team, stay up to date with product features, and chat with other contributors!
Once joining our Slack we recommend Introducing yourself in the #introductions channel. Tell us a bit about yourself and how you are currently using OpenMetadata if you are.
If you need help getting started in contributing, you can reach out in the #support channel and ask if anyone would be available to get you up to speed or just answer some questions.
If you just have suggestions for how to improve OpenMetadata you can submit your feedback in #feature-requests. If you have a fix or contribution in mind but need some guidance, please post in the #contributor channel with a description of the change before opening a new Github issue.