mirror of
https://github.com/rust-lang/rust.git
synced 2026-04-27 18:57:42 +03:00
Created a code review checklist
@@ -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+`
|
||||
Reference in New Issue
Block a user