Skip to main content

Contributing

GitHub Practices

  • We use GitHub for managing code, documentation, and support.
  • We use GitHub Projects for tracking work and GitHub pull requests for reviewing and merging code.
  • When working in our repos, please adhere to GitHub housekeeping guidelines when creating pull requests, ensuring clear titles and descriptions, linking to issues when applicable, and requesting reviews upon readiness

GitHub Housekeeping

  • When creating a pull request, ensure you have a clear title and description.
  • If applicable, link your pull request to an issue with the special keywords such as closes, fixes or resolves GitHub documentation for linking pull requests to issues.
  • If your pull request is not ready for review, convert it to a draft.
  • When your pull request is ready for review, remove the draft status and ensure all checks are passing.
  • When all checks are passing post the link to the PR into the # data-catalogue-devs channel to request a review
This page was last reviewed on 8 October 2024. It needs to be reviewed again on 8 April 2025 by the page owner #data-catalogue .
This page was set to be reviewed before 8 April 2025 by the page owner #data-catalogue. This might mean the content is out of date.