mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 21:40:12 +01:00
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.
This commit is contained in:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user