Skip to content

Commit

Permalink
[docs] Add a nits checklist to CodingStandards (pytorch#2055)
Browse files Browse the repository at this point in the history
  • Loading branch information
bertmaher authored Nov 19, 2018
1 parent 18d9a56 commit c63b521
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/CodingStandards.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,16 @@ people's changes! Anybody is allowed to review code and comment on patches.

All changes, by all developers, must be reviewed before they are committed to
the repository.

### Nits checklist

There are some common issues that we flag in PRs that can be solved
mechanically. Going through this checklist before submitting a PR will speed up
the review process by eliminating round-trips for feedback.

* Remember copyright headers on new source files.
* Prefer `llvm::StringRef` to `std::string`.
* Comments are complete sentences: begin with a capital, end with a period.
* Add Doxygen comments to every new class, method, function, global, etc.
* Boolean arguments should be tagged with a /* name_of_param */ comment.
* Always clang-format! (The linter will catch this, but it never hurts.)

0 comments on commit c63b521

Please sign in to comment.