Chandler CarruthandRichard Smith
cfd1ed8484
Rumdl already appears to have _significantly_ fewer bugs than prettier, and a solid LSP for editor integration. The tool is: https://github.com/rvben/rumdl/ I've separated out the change across three commits for easier review. The configuration tries to match the existing formatting, the changes to the all the files are to correct issues found by the new tool. Assisted-by: Antigravity with Gemini --------- Co-authored-by: Richard Smith <richard@metafoo.co.uk>
3.3 KiB
TODO
Table of contents
- TODO: Initial proposal setup
- Abstract
- Problem
- Background
- Proposal
- Details
- Rationale
- Alternatives considered
TODO: Initial proposal setup
TIP: Run
./new_proposal.py "TITLE"to do new proposal setup.
- Copy this template to
new.md, and create a commit. - Create a GitHub pull request, to get a pull request number.
- Add the
proposal draftlabel to the pull request.
- Add the
- Rename
new.mdto/proposals/p####.md, where####should be the pull request number. - Update the title of the proposal (the
TODOon line 1). - Update the link to the pull request (the
####on line 11). - Delete this section.
TODOs indicate where content should be updated for a proposal. See Carbon Governance and Evolution 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 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
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 and principles. This may evolve during review. Use links
to appropriate sections of /docs/project/goals.md,
and/or to documents in /docs/project/principles.
For example:
- Community and culture
- Language tools and ecosystem
- Performance-critical software
- Software and language evolution
- Code that is easy to read, understand, and write
- Practical safety and testing mechanisms
- Fast and scalable development
- Modern OS platforms, hardware architectures, and environments
- Interoperability with and migration from existing C++ code
Alternatives considered
TODO: What alternative solutions have you considered?