mirror of
https://github.com/rust-lang/rust.git
synced 2026-03-20 00:15:17 +00:00
Page:
Note code review
Pages
Anticipated breaking changes during 1.0 alpha
Community User Groups, Meetups, and Events
Community libraries
Doc continuous integration
Doc how to install an unofficial nightly for Windows
Doc Emacs Support
Doc FAQ Cheatsheet
Doc building for android
Doc building for ios
Doc detailed release notes
Doc examples
Doc friends of the tree
Doc language faq
Doc lowlevel details
Doc packages, editors, and other tools
Doc releases
Doc under construction FAQ
Doc vim support
Docs project structure
Docs
Games written in Rust
Home
Howto submit a rust bug report
IRC notifications channel
Lib datetime
Lib fmt
Lib html
Lib io
Lib rand
Lib re
Library editing
Libs
Meeting API review 2014 06 23
Meeting RFC triage 2014 06 19
Mixed language link time optimization
Note Building Rust Before 0.8 on Windows Systems
Note 0.5 priorities
Note Intrinsics
Note Rust performance fixes
Note bors usage
Note buildbots
Note code review
Note compiler snapshots
Note core team
Note development policy
Note getting started developing Rust
Note git workflow
Note guide for new contributors
Note operator overloading
Note priority issue criteria
Note research
Note rustc hacking guide back end
Note rustc hacking guide front end
Note rustc hacking guide middle end
Note rustc hacking guide
Note seeing LLVM output from rust
Note style guide
Note tag label names and definitions
Note testsuite
Note wiki conventions
Notes
OS Bridge 2013 tutorial
Operating system development
Projects using Rust
Rustpkg schedule
Sigil reference
Teaching Rust
The Rusticon
Using Rust on Windows
lib template
No results
7
Note code review
Nathan Typanski edited this page 2014-08-02 21:43:07 -07:00
Table of Contents
Code review checklist
- Code should respect the policy described in the style page.
- Commit message summaries have to be descriptive.
- Commit messages should be accurate: if it has deviated from top-level description, don't
r+without getting that fixed; see e.g. flip-i-mean-rev commit as an example of accidental deviation. - Almost every change should contain a test case as described in the testing page.
- Code optimization should contain a bench case as described in the bench section of the 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
LGTMinstead ofr+
All Categories:
- Docs -- For users
- Notes -- For developers
- Libs -- For library authors
- Meeting minutes