|
| 1 | +# `ref` |
| 2 | + |
| 3 | +<!-- |
| 4 | +Part of the Carbon Language project, under the Apache License v2.0 with LLVM |
| 5 | +Exceptions. See /LICENSE for license information. |
| 6 | +SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 7 | +--> |
| 8 | + |
| 9 | +[Pull request](https://github.com/carbon-language/carbon-lang/pull/5434) |
| 10 | + |
| 11 | +<!-- toc --> |
| 12 | + |
| 13 | +## Table of contents |
| 14 | + |
| 15 | +- [Abstract](#abstract) |
| 16 | +- [Problem](#problem) |
| 17 | +- [Background](#background) |
| 18 | +- [Proposal](#proposal) |
| 19 | +- [Details](#details) |
| 20 | +- [Rationale](#rationale) |
| 21 | +- [Alternatives considered](#alternatives-considered) |
| 22 | + |
| 23 | +<!-- tocstop --> |
| 24 | + |
| 25 | +## Abstract |
| 26 | + |
| 27 | +TODO: Describe, in a succinct paragraph, the gist of this document. This |
| 28 | +paragraph should be reproduced verbatim in the PR summary. |
| 29 | + |
| 30 | +## Problem |
| 31 | + |
| 32 | +TODO: What problem are you trying to solve? How important is that problem? Who |
| 33 | +is impacted by it? |
| 34 | + |
| 35 | +## Background |
| 36 | + |
| 37 | +TODO: Is there any background that readers should consider to fully understand |
| 38 | +this problem and your approach to solving it? |
| 39 | + |
| 40 | +## Proposal |
| 41 | + |
| 42 | +TODO: Briefly and at a high level, how do you propose to solve the problem? Why |
| 43 | +will that in fact solve it? |
| 44 | + |
| 45 | +## Details |
| 46 | + |
| 47 | +TODO: Fully explain the details of the proposed solution. |
| 48 | + |
| 49 | +## Rationale |
| 50 | + |
| 51 | +TODO: How does this proposal effectively advance Carbon's goals? Rather than |
| 52 | +re-stating the full motivation, this should connect that motivation back to |
| 53 | +Carbon's stated goals and principles. This may evolve during review. Use links |
| 54 | +to appropriate sections of [`/docs/project/goals.md`](/docs/project/goals.md), |
| 55 | +and/or to documents in [`/docs/project/principles`](/docs/project/principles). |
| 56 | +For example: |
| 57 | + |
| 58 | +- [Community and culture](/docs/project/goals.md#community-and-culture) |
| 59 | +- [Language tools and ecosystem](/docs/project/goals.md#language-tools-and-ecosystem) |
| 60 | +- [Performance-critical software](/docs/project/goals.md#performance-critical-software) |
| 61 | +- [Software and language evolution](/docs/project/goals.md#software-and-language-evolution) |
| 62 | +- [Code that is easy to read, understand, and write](/docs/project/goals.md#code-that-is-easy-to-read-understand-and-write) |
| 63 | +- [Practical safety and testing mechanisms](/docs/project/goals.md#practical-safety-and-testing-mechanisms) |
| 64 | +- [Fast and scalable development](/docs/project/goals.md#fast-and-scalable-development) |
| 65 | +- [Modern OS platforms, hardware architectures, and environments](/docs/project/goals.md#modern-os-platforms-hardware-architectures-and-environments) |
| 66 | +- [Interoperability with and migration from existing C++ code](/docs/project/goals.md#interoperability-with-and-migration-from-existing-c-code) |
| 67 | + |
| 68 | +## Alternatives considered |
| 69 | + |
| 70 | +TODO: What alternative solutions have you considered? |
0 commit comments