From efb497d2eede6fa7a275f8da7b7caeb233b9daa9 Mon Sep 17 00:00:00 2001 From: Flavio Percoco Premoli Date: Sun, 19 Jan 2014 04:43:27 -0800 Subject: [PATCH] Created a code review checklist --- Note-code-review.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Note-code-review.md diff --git a/Note-code-review.md b/Note-code-review.md new file mode 100644 index 0000000..31cfea3 --- /dev/null +++ b/Note-code-review.md @@ -0,0 +1,20 @@ +Code review checklist +--------------------- + +* Code should respect the policy described in the [style](https://github.com/mozilla/rust/wiki/Note-style-guide) page. +* Commit message summaries have to be descriptive. +* Almost every change should contain a test case as described in the [testing](https://github.com/mozilla/rust/wiki/Doc-unit-testing) page. +* Code optimization should contain a bench case as described in the [bench](https://github.com/mozilla/rust/wiki/Doc-unit-testing#benchmarking) section of the [testing](https://github.com/mozilla/rust/wiki/Doc-unit-testing) page. +* Look for commits that could be squashed. + +General Suggestions +------------------- + +* Don't do partial reviews. If you're reviewing a PR, address it completely. This will reduce the pending time of PRs. +* Whenever something can be improved or should be changed, be as detailed as possible in your comments. This will help contributors that are not familiar with the code to understand better what you're saying. +* Add references whenever it's possible. For instance, when a benchmark is requested, link the benchmark section to your comment, unless you're sure the contributor knows that already. + +Non core contributors +--------------------- + +* If you reviewed a patch and code looks good to you, use `LGTM` instead of `r+`