Add a suggesting change section to code review guidelines (#678)

* Add a suggesting change section to code review guidelines Suggesting changes is becoming more popular, and having guidelines can make code reviews more efficient. --------- Co-authored-by: Stefanni Brasil <[email protected]> Co-authored-by: Justin Toniazzo <[email protected]>
thoughtbot · Feb 17, 2023 · 2a66bcb · 2a66bcb
1 parent 8b7825c
commit 2a66bcb
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/code-review/README.md b/code-review/README.md
@@ -65,6 +65,11 @@ experience, refactors the existing code). Then:
 - Seek to understand the author's perspective.
 - Sign off on the pull request with a 👍 or "Ready to merge" comment.
 - Remember that you are here to provide feedback, not to be a gatekeeper.
+- When suggesting changes using the "Add a suggestion" feature:
+  - Communicate clearly which lines you suggest adding/removing.
+  - Test the suggested changes to validate it works whenever possible.
+  - When not possible, let the pull request author know that you did not test the suggestion.
+  - Provide some context to let the author know why you're suggesting the change.
 
 ## Style Comments