Files
carbon-lang/proposals/template.md
T
Jon Meow 6c3b50ad5e Move rationale to the proposal template (#459)
In support of #426. The decisions need to be merged into proposals, but I want to handle that separately.
2021-04-14 15:15:07 -07:00

70 lines
2.1 KiB
Markdown

# TODO
<!--
Part of the Carbon Language project, under the Apache License v2.0 with LLVM
Exceptions. See /LICENSE for license information.
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
-->
[Pull request](https://github.com/carbon-language/carbon-lang/pull/####)
<!-- toc -->
## Table of contents
- [TODO: Initial proposal setup](#todo-initial-proposal-setup)
- [Problem](#problem)
- [Background](#background)
- [Proposal](#proposal)
- [Details](#details)
- [Rationale based on Carbon's goals](#rationale-based-on-carbons-goals)
- [Alternatives considered](#alternatives-considered)
<!-- tocstop -->
## TODO: Initial proposal setup
> TIP: Run `./scripts/new_proposal.py "TITLE"` to do new proposal setup.
1. Copy this template to `new.md`, and create a commit.
2. Create a GitHub pull request, to get a pull request number.
- Add the `proposal` and `WIP` labels to the pull request.
3. Rename `new.md` to `/proposals/p####.md`, where `####` should be the pull
request number.
4. Update the title of the proposal (the `TODO` on line 1).
5. Update the link to the pull request (the `####` on line 11).
6. Delete this section.
TODOs indicate where content should be updated for a proposal. See
[Carbon Governance and Evolution](/docs/project/evolution.md) for more details.
## Problem
TODO: What problem are you trying to solve? How important is that problem? Who
is impacted by it?
## Background
TODO: Is there any background that readers should consider to fully understand
this problem and your approach to solving it?
## Proposal
TODO: Briefly and at a high level, how do you propose to solve the problem? Why
will that in fact solve it?
## Details
TODO: Fully explain the details of the proposed solution.
## Rationale based on Carbon's goals
TODO: How does this proposal effectively advance Carbon's goals? Rather than
re-stating the full motivation, this should connect that motivation back to
Carbon's stated goals for the project or language. This may evolve during
review.
## Alternatives considered
TODO: What alternative solutions have you considered?