Files
carbon-lang/proposals/template.md
T
Jon Meow be116a46c9 Adjust md tab width to work better cross-markdown-parser (#124)
We're running into issues with md handlers that expect this kind of 4-space indent. It should be cross-compatible with GH, so switch, even though it feels a little churny.

Manual edits are to:

- .prettierrc.yaml:
    - rename from .prettierrc
    - add tabWidth (primary change)
    - add trailingComma (fix vimPrettier skew)
- contribution_tools.md: Fix remarks about .prettierrc.yaml
- pre-commit-toc.js: indent, bullets
- pre-commit-proposal-list.py: indent of output

The rest is the result of `pre-commit run --all-files`

Unfortunately this'll probably depend on the change being propagated into PR branches, so I wouldn't be surprised if we see regressions for a bit. We'll also need to nudge people to update .vimrc's. Hopefully the pre-commit GH action helps catch issues.
2020-07-27 10:47:38 -07:00

1.7 KiB

TODO

Pull request

Table of contents

TODO: Initial proposal setup

TIP: Run ../src/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 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.

Alternatives considered

TODO: What alternative solutions have you considered?