From 22f52a203e0c5093061e6298568ba00166f43cf9 Mon Sep 17 00:00:00 2001 From: Paul McCarthy Date: Tue, 19 Dec 2023 10:34:55 +0000 Subject: [PATCH] Adding PR submission section to contributors guide --- src/contributing.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/contributing.md b/src/contributing.md index 62ad0b8..bcc2af6 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -52,6 +52,18 @@ A list of good first issues can be found from the Kuadrant Github [projects boar On the rare occasion that there are no good first issues available, that’s OK! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can reach out via the [Public Slack channel][SlackChannelURL] for suggestions and/or guidance. +## Submitting Pull Requests + +When submitting a pull request against one of the Kuadrant component repositories, should the PR address a particular Github issue please make sure to reference it in the PR description. That said, it is not mandatory for a PR to have an associated issue referenced. In the event of a standalone PR that doesn't have an associated issue, please add a detailed description of the changes included. Adding *What* and *Why* sections is a good start. For example, *What* is the purpose of this change and *Why* is it required and/or being implemented in this way? + +The Kuadrant project owners and maintainers strive to review and/or respond to all newly submitted PRs in a timely manner, however, if you're finding it difficult to get someone to review your PR, please reach out directly on [Slack][SlackChannelURL] or [mail][MailingList] + +Finally, it is recommended that you squash your changes into a single commit where possible. If this is not feasible please ensure that your commits are representing a logical piece of work that can be reviewed independently within the PR. + +## Signing Commits + +All commits to be accepted to Kuadrant component codebases are required to be signed. Refer to [this page](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) about signing your commits. +