From 82996e8fed2a2d47e9405d306bca8b4c018e1dd3 Mon Sep 17 00:00:00 2001 From: Tom Whiteley Date: Mon, 16 Mar 2026 16:21:41 +0000 Subject: [PATCH 1/2] Adding CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..03ce14d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +All contributions to this project are subject to the [MIT License](https://foss-haas.mit-license.org/). By submitting a contribution, you agree to license your work under these terms. + +## Contribution Process + +### 1. Issue First + +All contributions from outside the core team require an **Issue First** approach. Before submitting a pull request (PR), you must: + +- Open an issue in the repository. +- Ensure the issue includes: + - **Clear problem statement:** Describe the issue or feature request. + - **Reproduction steps:** If reporting a bug, provide steps to reproduce it. + - **Proposed approach:** Outline your suggested solution or implementation. + - **Why this change matters:** Explain the impact or necessity of the change. +- Tag `@sanger/psd-developers` in the issue to bring it to the attention of a maintainer. +- Wait for the issue to be assigned or approved by a maintainer. + +### 2. Pull Request + +Once your issue is approved: + +- Fork the repository and create a branch for your changes. +- Submit a PR referencing the approved issue. +- Ensure your code adheres to the project's coding standards and passes all tests. + +### 3. Review + +Maintainers will review your PR. Address any feedback before merging. \ No newline at end of file From 02c5f83ff54977ef1117b9a993d22e1dd0789a59 Mon Sep 17 00:00:00 2001 From: Stephen Hulme Date: Thu, 7 May 2026 14:10:39 +0100 Subject: [PATCH 2/2] docs: add link to contribution guidelines from readme --- CONTRIBUTING.md | 2 +- README.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03ce14d..77108fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,4 +27,4 @@ Once your issue is approved: ### 3. Review -Maintainers will review your PR. Address any feedback before merging. \ No newline at end of file +Maintainers will review your PR. Address any feedback before merging. diff --git a/README.md b/README.md index fe630ab..a49c187 100644 --- a/README.md +++ b/README.md @@ -249,6 +249,7 @@ and tags to GitHub. ## Contributing Bug reports and pull requests are welcome on GitHub at . +Please read the [contribution guidelines](CONTRIBUTING.md) for details on the contribution process. ## License