Skip to main content

Contributing

We always welcome contributions to help make DataHub better. Take a moment to read this document if you would like to contribute.

Provide Feedback​

Have ideas about how to make DataHub better? Head over to DataHub Feature Requests and tell us all about it!

Show your support for other requests by upvoting; stay up to date on progress by subscribing for updates via email.

Reporting Issues​

We use GitHub issues to track bug reports and submit pull requests.

If you find a bug:

  1. Use the GitHub issue search to check whether the bug has already been reported.

  2. If the issue has been fixed, try to reproduce the issue using the latest master branch of the repository.

  3. If the issue still reproduces or has not yet been reported, try to isolate the problem before opening an issue.

Submitting a Request For Comment (RFC)​

If you have a substantial feature or a design discussion that you'd like to have with the community, follow the RFC process outlined here.

Submitting a Pull Request (PR)​

Before you submit your Pull Request (PR), consider the following guidelines:

  • Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  • Open a pull request (PR) following GitHub’s standard workflow.
  • Please make sure to follow our PR Title Format for clarity and consistency.
  • PRs are squashed and merged, resulting in a single commit with the PR title as the commit message.
  • If there are any breaking changes, potential downtime, deprecations, or big features, please add an update in Updating DataHub under Next.
  • That's it! Thank you for your contribution!

Product-update CTA merge check​

The Cloud/Core "What's New" toast CTA is a live URL republished from product-update.json / product-update-saas.json. GitHub Actions job product_update_cta_live GET-probes those links on every PR targeting master (and releases/** / hotfixes/**). It is not part of Gradle, so the rest of CI can go green while a blog post is still unpublished.

Repo admins: add product_update_cta_live as a required status check on master (classic branch protection or a ruleset). Until that is set, the job is advisory and will not block merge. Do not require rerun_failed_product_update_cta.

After the URL returns 2xx, re-run that one job (or wait up to 15 minutes for the scheduled retry in product-update CTA rerun). Do not rerun the full CI suite.

PR Title Format​

<type>[optional scope]: <description>

Example:

feat(parser): add ability to parse arrays

Type​

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • refactor: A code change that neither fixes a bug nor adds a feature
  • docs: Documentation only changes
  • test: Adding missing tests or correcting existing tests
  • perf: A code change that improves performance
  • style: Changes that do not affect the meaning of the code (whitespace, formatting, missing semicolons, etc.)
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • chore: Maintenance tasks (dependency bumps, tooling, etc.)