diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 22a085f07..bdda50a6b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,7 +14,7 @@ If your change doesn't seem to apply, please leave them unchecked. -* [ ] I have performed a self-review of this change -* [ ] Changes have been tested +* [ ] I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) +* [ ] Changes have been [tested](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test) * [ ] Changes are documented -* [ ] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0/) +* [ ] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) diff --git a/docs/contributing.md b/docs/contributing.md index c5e564f16..b4e61d9e2 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -2,6 +2,12 @@ We welcome contributions from the community! This guide will help you understand our contribution process and requirements. +## Development guidelines + +1. Small PRs ([blogpost](https://testing.googleblog.com/2024/07/in-praise-of-small-pull-requests.html)) +1. When fixing a bug, include a test that reproduces the issue in the same pull request (the test should fail without your changes) +1. If you are refactoring, ensure adequate test coverage exists for the target area. If coverage is insufficient, create tests in a separate pull request first. This approach provides a safety net for validating current behavior and simplifies code reviews. + ## Build and Test Prerequisites: