Mention that self-review is not a subtitute for code comments
Hector Sanjuan committed
Apr 29, 2020 at 22:49 UTC
44b8bdb930a1f033bbb7494cf98c875472a29a8a
1 file changed
+5
-3
.github/auto-comment.yml
+5
-3
@@ -16,9 +16,11 @@ pullRequestOpened: >
16
and stakeholders linked/mentioned.
17
18
* You have self-reviewed it yourself. Please make a self-review and leave
19
- comments providing the rationale behind your changes as needed. Expect
20
- that the person reviewing this code next does not have to be super
21
- familiar with the affected codebase. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines)
19
+ comments providing the rationale behind your changes as needed (this is
20
+ not a substitute for code comments though!). Expect that the person
21
+ reviewing this code next does not have to be super familiar with the
22
+ affected codebase. Follow the [code contribution
23
+ guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines)
24
when they apply.
25
26
* Getting additional reviews from additional people (community members