From 75c9ed2d4bf3805ddbcc71402c20650217720d18 Mon Sep 17 00:00:00 2001 From: R-Lawton Date: Thu, 2 Jul 2026 17:08:01 +0100 Subject: [PATCH 1/3] docs: add contributing guide with issue policy Link to the centralised Kuadrant contributing guide and add a repo-specific issue policy requiring assignment before work begins. Co-Authored-By: Claude Opus 4.6 (1M context) Signed-off-by: R-Lawton --- CONTRIBUTING.md | 126 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..781dc97 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,126 @@ +# Contributing + +For general contribution guidelines, PR requirements, and issue triage rules, see the [Kuadrant contributing guide](https://github.com/Kuadrant/.github/blob/main/CONTRIBUTING.md). + +## Issue Policy + +**Do not start work on an issue unless it has been assigned to you by a maintainer.** + +Issues go through a triage and planning process before they are ready for contribution. Working on unassigned issues — whether manually or via AI coding agents — wastes your time and ours. + +**Pull requests submitted against unassigned issues will be automatically closed and will not be reopened.** + +If you're interested in contributing to an issue, leave a comment and wait for a maintainer to assign it to you before starting any work. + +## Contributions + +We welcome code and non-code contributions to our project. Non-code contributions can come in the form of documentation updates, bug reports, enhancement requests, and feature requests. + +### Finding Issues to Work On + +The best place to start is to look through our issues for [bugs](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors. + +Remember: only work on issues that are `triage/accepted` and assigned to you. + +### Bug Reporting + +If you found a bug, please submit an [issue](https://github.com/Kuadrant/developer-portal-controller/issues/new) describing the problem. Include: + +- Steps to reproduce the bug +- The Kubernetes/OpenShift version you are running +- CRD versions installed +- Any relevant logs + +### Enhancement Requests + +If you want an enhancement of a feature or workflow, submit an [issue](https://github.com/Kuadrant/developer-portal-controller/issues/new) describing the enhancement. Include: + +- What you are wanting to see improved +- The current behavior +- The new behavior you wish to see + +### Feature Requests + +If you want to see a new feature, file an [issue](https://github.com/Kuadrant/developer-portal-controller/issues/new) detailing the new feature. Include: + +- What you are trying to achieve with the new feature +- What you will need +- Any relevant documentation or information on the new feature + +### Documentation + +If there is documentation that is unclear or could use some improvements, please raise an issue or submit a pull request. + +### Pull Requests + +If you want to submit code changes to the project, here are some guidelines: + +1. **Create a Branch** + + ```bash + git checkout -b your-feature-branch + ``` + +2. **Implement Your Changes** + + Make your code changes, ensuring that you follow the project's coding standards and best practices. + + If you modify API types in `api/v1alpha1/*_types.go`, regenerate code and CRDs: + + ```bash + make manifests generate + ``` + +3. **Testing** + + Ensure all tests pass before committing. + + ```bash + make test # run unit tests with coverage + make test-e2e # run e2e tests (creates/deletes Kind cluster) + go test ./internal/controller -v # run controller tests only + ``` + +4. **Linting and Formatting** + + Ensure your code passes linting and formatting checks. + + ```bash + make fmt # run go fmt + make vet # run go vet + make lint # run golangci-lint + ``` + +5. **Ensure CI Passes** + + Your contributions will need to pass the Continuous Integration (CI) tests for pull requests. + +6. **Commit Changes** + + Use meaningful commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) specification. + + ```bash + git commit -m "feat: add new feature" + ``` + +7. **Push to Your Fork** + + ```bash + git push origin your-feature-branch + ``` + +8. **Open a Pull Request** + + Go to the original repository and click on **New Pull Request**. Provide a clear description of your changes, including any issues your PR fixes, acceptance criteria, and any special notes to the reviewers. + +## Commit Messages + +Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification: + +- `feat`: A new feature. +- `fix`: A bug fix. +- `docs`: Documentation changes. +- `style`: Code style changes (formatting, missing semi-colons, etc.). +- `refactor`: Code changes that neither fix a bug nor add a feature. +- `test`: Adding or correcting tests. +- `chore`: Changes to the build process or auxiliary tools. From 16b24789ea47b498340cf9a4060cb6afc8efd564 Mon Sep 17 00:00:00 2001 From: Rachel Lawton Date: Fri, 3 Jul 2026 15:57:37 +0100 Subject: [PATCH 2/3] docs: add maintainers-only issue policy to contributing guide Signed-off-by: Rachel Lawton Signed-off-by: R-Lawton --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 781dc97..4ce2b1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,8 @@ Issues go through a triage and planning process before they are ready for contri If you're interested in contributing to an issue, leave a comment and wait for a maintainer to assign it to you before starting any work. +Issues labelled `maintainers-only` are reserved for the maintainer team and are not available for external contribution. + ## Contributions We welcome code and non-code contributions to our project. Non-code contributions can come in the form of documentation updates, bug reports, enhancement requests, and feature requests. From 3937623c69c2b53781fe9f14c36d8a942236a763 Mon Sep 17 00:00:00 2001 From: Rachel Lawton Date: Fri, 3 Jul 2026 16:17:04 +0100 Subject: [PATCH 3/3] docs: remove help wanted label reference from contributing guide Signed-off-by: Rachel Lawton Signed-off-by: R-Lawton --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ce2b1f..2a2e3ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ We welcome code and non-code contributions to our project. Non-code contribution ### Finding Issues to Work On -The best place to start is to look through our issues for [bugs](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors. +The best place to start is to look through our issues for [bugs](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug) and [good first issues](https://github.com/Kuadrant/developer-portal-controller/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). These are a great starting point for new contributors. Remember: only work on issues that are `triage/accepted` and assigned to you.