From ea0a37dbf3258851987e422b811694a7cddd44bd Mon Sep 17 00:00:00 2001 From: David Sankel Date: Fri, 26 Aug 2022 14:49:25 -0400 Subject: [PATCH] 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. --- proposals/scripts/template.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/proposals/scripts/template.md b/proposals/scripts/template.md index b470dbb499eb..0e1ef1d8f6b1 100644 --- a/proposals/scripts/template.md +++ b/proposals/scripts/template.md @@ -13,6 +13,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception ## Table of contents - [TODO: Initial proposal setup](#todo-initial-proposal-setup) +- [Abstract](#abstract) - [Problem](#problem) - [Background](#background) - [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 [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 TODO: What problem are you trying to solve? How important is that problem? Who