Update pull request guidelines (#6415)

* Asking PR reviewers to provide a rationale for any suggestions. * Link to PR guidelines from PR template * Update CONTRIBUTING.md Co-authored-by: Geoff Rowland <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Geoff Rowland <[email protected]> --------- Co-authored-by: Geoff Rowland <[email protected]>
elastic · Dec 26, 2024 · ffaaafb · ffaaafb
1 parent d7da688
commit ffaaafb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -28,6 +28,7 @@ Add a checklist of things that are required to be reviewed in order to have the
 List here all the items you have verified BEFORE sending this PR. Please DO NOT remove any item, striking through those that do not apply. (Just in case, strikethrough uses two tildes. ~~Scratch this.~~)
 -->
 
+- [ ] I have read and understood the [pull request guidelines](https://github.com/elastic/elastic-agent/blob/main/CONTRIBUTING.md#pull-request-guidelines) of this project.
 - [ ] My code follows the style guidelines of this project
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
@@ -78,4 +79,4 @@ Trigger comments:
 PR labels:
 skip-ci           Skips unit and integration tests
 skip-it           Skips integration tests
--->
+-->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -60,4 +60,6 @@ Keep these in mind as both authors and reviewers of PRs:
 
 * I must not focus on personal preferences or nitpicks. If I understand the code in the PR but simply would've implemented the same solution a different way that's great but it is not feedback that belongs in the PR. Such feedback only serves to slow down progress for little to no gain.
 
+* If I'm making a suggestion, I must provide a rationale for it.  It should be clear to the author of the PR why my suggestion is better than what is already in the PR.
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -60,4 +60,6 @@ Keep these in mind as both authors and reviewers of PRs:

		* I must not focus on personal preferences or nitpicks. If I understand the code in the PR but simply would've implemented the same solution a different way that's great but it is not feedback that belongs in the PR. Such feedback only serves to slow down progress for little to no gain.

		* If I'm making a suggestion, I must provide a rationale for it. It should be clear to the author of the PR why my suggestion is better than what is already in the PR.