Przeglądaj źródła

Add Abstract Section (#1895)

Reading through extensive problem and background documentation before seeing
what is being proposed is tedious for a reader. An abstract section at the
beginning of a document that provides a succinct summary helps a lot. We
propose adding such a section to our proposal template.
David Sankel 3 lat temu
rodzic
commit
ea0a37dbf3
1 zmienionych plików z 6 dodań i 0 usunięć
  1. 6 0
      proposals/scripts/template.md

+ 6 - 0
proposals/scripts/template.md

@@ -13,6 +13,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 ## Table of contents
 ## Table of contents
 
 
 -   [TODO: Initial proposal setup](#todo-initial-proposal-setup)
 -   [TODO: Initial proposal setup](#todo-initial-proposal-setup)
+-   [Abstract](#abstract)
 -   [Problem](#problem)
 -   [Problem](#problem)
 -   [Background](#background)
 -   [Background](#background)
 -   [Proposal](#proposal)
 -   [Proposal](#proposal)
@@ -38,6 +39,11 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 TODOs indicate where content should be updated for a proposal. See
 TODOs indicate where content should be updated for a proposal. See
 [Carbon Governance and Evolution](/docs/project/evolution.md) for more details.
 [Carbon Governance and Evolution](/docs/project/evolution.md) for more details.
 
 
+## Abstract
+
+TODO: Describe, in a succinct paragraph, the gist of this document. This
+paragraph should be reproduced verbatim in the PR summary.
+
 ## Problem
 ## Problem
 
 
 TODO: What problem are you trying to solve? How important is that problem? Who
 TODO: What problem are you trying to solve? How important is that problem? Who