From d005ac034a5f4e7921f4078fe34387614c5b54da Mon Sep 17 00:00:00 2001 From: Jon Ross-Perkins Date: Fri, 7 Feb 2025 14:13:19 -0800 Subject: [PATCH] Add notes about PR labels (#4913) Add a code review note for PRs. Background discussion of NFC happened [a month ago](https://docs.google.com/document/d/1Iut5f2TQBrtBNIduF4vJYOKfw7MbS8xH_J01_Q4e6Rk/edit?resourcekey=0-mc_vh5UzrzXfU4kO-3tOjA&tab=t.0#heading=h.brv2irjg39vf), it just slipped my mind to update docs. --- docs/project/code_review.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/project/code_review.md b/docs/project/code_review.md index 979586189f95..2294cc5e52b8 100644 --- a/docs/project/code_review.md +++ b/docs/project/code_review.md @@ -18,6 +18,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - [Write good change descriptions](#write-good-change-descriptions) - [First line](#first-line) - [Body](#body) + - [Pull request labels](#pull-request-labels) - [Make small changes](#make-small-changes) - [Responding to review comments](#responding-to-review-comments) - [Responding to questions or confusion](#responding-to-questions-or-confusion) @@ -193,6 +194,22 @@ in order to be effective. Also consider what information someone else will need a year in the future when doing archaeology on the codebase and they come across your change without any context. +#### Pull request labels + +GitHub labels are used on PRs, such as +[toolchain](https://github.com/carbon-language/carbon-lang/labels/toolchain). +These are automatically added based on affected directories. + +We do not put labels in PR descriptions; for example, we would write +`Implements type deduction` instead of `[feature] Type deduction`, or +`Fix crash in function imports` instead of `[bug] Crash in function imports`. + +Given the current size and state of Carbon, we believe the `[feature]`-style PR +labeling would add too much process for their benefit. Additionally, in contrast +with LLVM's +[`[NFC]` label policies](https://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access), +Carbon changes are always reviewed prior to commit. + ### Make small changes Small changes have many benefits: