소스 검색

Address a TODO by linking to the code review document. (#177)

The pull request workflow was supposed to connect to the review guidance
anyways, but the link hadn't been added.

Also adds a TOC to the pull request workflow document as it was missing
one.
Chandler Carruth 5 년 전
부모
커밋
2ebf7ca0a0
1개의 변경된 파일16개의 추가작업 그리고 4개의 파일을 삭제
  1. 16 4
      docs/project/pull_request_workflow.md

+ 16 - 4
docs/project/pull_request_workflow.md

@@ -6,6 +6,19 @@ Exceptions. See /LICENSE for license information.
 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 -->
 
+## Table of contents
+
+<!-- toc -->
+
+-   [Trunk based development](#trunk-based-development)
+    -   [Green tests](#green-tests)
+-   [Always use pull requests (with review) rather than pushing directly](#always-use-pull-requests-with-review-rather-than-pushing-directly)
+-   [Small, incremental changes](#small-incremental-changes)
+    -   [Managing pull requests with multiple commits](#managing-pull-requests-with-multiple-commits)
+-   [Linear history](#linear-history)
+
+<!-- tocstop -->
+
 Carbon repositories follow a few basic principles:
 
 -   Development directly on the `trunk` branch and
@@ -30,10 +43,9 @@ version control:
     -   How does the main branch and project evolve over time?
     -   How was a bug or surprising thing introduced?
 
-Note that this isn't a complete guide to doing code reviews, and just focuses on
-the mechanical workflow and branch management. TODO: Add an explicit link to
-more detailed guidance on managing pull request based code reviews when it is
-developed.
+Note that this document focuses on the mechanical workflow and branch
+management. Details of the code review process are in their own
+[document](code_review.md).
 
 ## Trunk based development