carbon-language/carbon-lang
1
0
Fork 0
mirror of https://github.com/carbon-language/carbon-lang.git synced 2026-10-06 06:44:46 +01:00
Code Issues Packages Projects Releases 10 Wiki Activity

Clarify code review applies to docs in CONTRIBUTING (#262)

Browse Source 
And add note about rebasing issues
This commit is contained in:
Jon Meow
2021-02-10 10:36:36 -08:00
committed by GitHub
parent b3de19639d
commit 7a1abddb4f
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -2
View File
@@ -212,6 +212,10 @@ follow the Carbon documentation and coding styles.
maintaining it.
- The appropriate [style](#style) is applied.
- The [license](#license) is present in all contributions.
- [Code review](/docs/project/code_review.md) is used to improve the
correctness, clarity, and consistency of all contributions.
- Please avoid rebasing PRs after receiving comments; it can break
viewing of the comments in files.
- For documentation:
@@ -242,8 +246,6 @@ follow the Carbon documentation and coding styles.
It helps to contribute a fix!
- Code changes should be made with API compatibility and evolvability in
mind.
- [Code review](/docs/project/code_review.md) is used to improve the
correctness, clarity, and consistency of contributions.
- Keep in mind that code contribution guidelines are incomplete while we
start work on Carbon, and may change later.
docs/project/code_review.md
+4 -3
View File
@@ -35,9 +35,10 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
## High level goals of code review
Code review serves several goals in the Carbon project. It directly improves the
correctness, clarity, and consistency of the code. These improvements range from
the high-level functionality down through the design and implementation details.
It also promotes team ownership and spreads knowledge across the team.
correctness, clarity, and consistency of contributions, including both code and
documentation. These improvements range from the high-level functionality down
through the design and implementation details. It also promotes team ownership
and spreads knowledge across the team.
More detailed discussions can be found in chapter 9 "Code Review" of the book
_[Software Engineering at Google](https://www.amazon.com/Software-Engineering-Google-Lessons-Programming/dp/1492082791)_