Contributing

Thanks for your interest in contributing to MSS Pipelines Guidance.

Who can contribute

Contributions are currently limited to ONS colleagues.

Conventions

  • Documentation structure follows Diataxis: https://diataxis.fr/
  • Use Conventional Commits for Git commit messages: https://www.conventionalcommits.org/

Contribution workflow

  1. Start by raising an issue describing the change you want to make.
  2. Request edit access from the code owners or fork the repository.
  3. Create a branch and make your changes.
  4. Open a pull request that links to your issue.
  5. We will review and merge approved changes.
    • Release notes are generated automatically by GitHub from merged changes when a release is created.

What to include in your change

  • Keep content aligned with Maintainable, Scalable, and Sustainable (MSS) principles.
  • Place new content in the correct Diataxis section.
  • Keep pages concise and focused on a single purpose.