From 71831267b664daa710e4e72b8256c8ffbc071ea4 Mon Sep 17 00:00:00 2001
From: Alejandro Campos Magencio <33097296+magencio@users.noreply.github.com>
Date: Tue, 9 Feb 2021 09:13:26 +0100
Subject: [PATCH] Improves the main Code Reviews read me to add visibility of
 contents (#506)

* Adds detailed summary of contents to Code Reviews section

* Reorganizes table of contents a bit and adds FAQ details

* Adds detailed summary of contents to Code Reviews section

* Reorganizes table of contents a bit and adds FAQ details
---
 code-reviews/README.md | 74 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)

diff --git a/code-reviews/README.md b/code-reviews/README.md
index e22ba39384..682b1a59d3 100644
--- a/code-reviews/README.md
+++ b/code-reviews/README.md
@@ -18,6 +18,80 @@ Code reviews is a way to have a conversation about the code where participants w
 - [FAQ](./faq.md)
 - [Resources](#resources)
 
+### Summary of contents
+
+- [Process Guidance: General](./process-guidance/README.md#general-guidance)
+  - [Pull Requests](./pull-requests.md)
+    - [General Process](./pull-requests.md#general-process)
+    - [Size Guidance](./pull-requests.md#size-guidance)
+    - [Commit Message Standardization](./pull-requests.md#commit-message-standardization)
+    - [Pull Request Template](./pull-request-template.md)
+  - Qualified PRs
+    - Reflect well-defined, concise tasks
+    - Compact in content
+  - Guidelines
+    - SLAs for code reviews
+    - Manage tasks pending for review
+      - [Customize AzDO task boards](./process-guidance/customize-ado.md#task-boards)
+    - Leverage [code review tools](./tools.md)
+  - [Measuring code review process](./process-guidance/README.md#measuring-code-review-process)
+- [Process Guidance: Authors](./process-guidance/author-guidance.md)
+  - [Add relevant reviewers](./process-guidance/author-guidance.md#add-relevant-reviewers)
+    - [Customize Reviewers Policy](./process-guidance/customize-ado.md#reviewer-policies)
+  - [Address comments](./process-guidance/author-guidance.md#be-open-to-receive-feedback)
+    - Resolve if change has been made
+    - Provide reason for "won't fix"
+    - Discuss comments in the review
+  - [Track progress](./process-guidance/author-guidance.md#track-progress)
+- [Process Guidance: Reviewer](./process-guidance/reviewer-guidance.md)
+  - [Focus](./process-guidance/reviewer-guidance.md)
+    - Correctness of business logic
+    - Correctness of tests
+    - Readability and maintainability
+    - Checklist of common errors
+  - [General guidance](./process-guidance/reviewer-guidance.md#general-guidance)
+    - [Understand the code](./process-guidance/reviewer-guidance.md#understand-the-code-you-are-reviewing)
+    - [Be considerate](./process-guidance/reviewer-guidance.md#be-considerate)
+    - [Make comments clear](./process-guidance/reviewer-guidance.md#make-comments-clear)
+    - [Decide on a common standard and automate with e.g. linters](./process-guidance/reviewer-guidance.md#decide-on-a-common-standard-for-each-language)
+  - [First design pass](./process-guidance/reviewer-guidance.md#first-design-pass)
+    - [PR overview](./process-guidance/reviewer-guidance.md#pull-request-overview)
+    - [User facing, UI changes](./process-guidance/reviewer-guidance.md#user-facing-changes)
+    - [Design](./process-guidance/reviewer-guidance.md#design)
+  - [Code quality pass](./process-guidance/reviewer-guidance.md#code-quality-pass)
+    - [Complexity](./process-guidance/reviewer-guidance.md#complexity)
+    - [Naming/readability](./process-guidance/reviewer-guidance.md#naming_readability)
+    - [Error handling](./process-guidance/reviewer-guidance.md#error-handling)
+    - [Functionality](./process-guidance/reviewer-guidance.md#functionality)
+    - [Style](./process-guidance/reviewer-guidance.md#style)
+    - [Tests](./process-guidance/reviewer-guidance.md#tests)
+- [Evidence and Measures](./evidence-and-measures/README.md)
+  - [Evidence](./evidence-and-measures/README.md#evidence)
+    - [Branch policies](./evidence-and-measures/branch-policy.md)
+    - Builds include linters and run unit tests
+    - Bug work items
+    - Update code review checklist
+    - Improve skills as code reviewers
+  - [Measures](./evidence-and-measures/README.md#measures)
+    - Collect metrics e.g. Defect Removal Efficiency, Time metrics, Lines of Code
+    - Manual tracking vs. AzDO dasboards
+- [Language Specific Guidance](./recipes/README.md)
+  - [Bash](./recipes/Bash.md)
+  - [C#](./recipes/CSharp.md)
+  - [Go](./recipes/Go.md)
+  - [Java](./recipes/Java.md)
+  - [JavaScript and TypeScript](./recipes/javascript-and-typescript.md)
+  - [Markdown](./recipes/Markdown.md)
+  - [Python](./recipes/Python.md)
+  - [Terraform](./recipes/Terraform.md)
+- [FAQ](./faq.md)
+  - [Large PRs?](./faq.md#we-experience-very-large-prs-how-can-we-fix-this)
+  - [Slow code reviews?](./faq.md#we-experience-slow-code-reviews-causing-delays-in-delivering-features)
+  - [Complex PRs?](./faq.md#reviewing-a-complex-pr-on-github-can-be-hard-is-there-a-more-integrated-way)
+  - [Enforcing code reviews](./faq.md#how-can-we-enforce-code-reviews)
+  - [Code Reviews and pair/mob programming](./faq.md#we-pair-or-mob-why-do-we-need-code-reviews)
+- [Resources](#resources)
+
 ## Resources
 
 - [Code review tools](tools.md)