csharplang/proposals/proposal-template.md

43 lines
1.3 KiB
Markdown
Raw Normal View History

2017-01-27 20:02:27 +01:00
# FEATURE_NAME
* [x] Proposed
* [ ] Prototype: [Complete](https://github.com/PROTOTYPE_OWNER/roslyn/BRANCH_NAME)
* [ ] Implementation: [In Progress](https://github.com/dotnet/roslyn/BRANCH_NAME)
* [ ] Specification: [Not Started](pr/1)
## Summary
[summary]: #summary
One paragraph explanation of the feature.
2017-01-27 20:02:27 +01:00
## Motivation
[motivation]: #motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
## Detailed design
[design]: #detailed-design
This is the bulk of the proposal. Explain the design in enough detail for somebody familiar with the language to understand, and for somebody familiar with the compiler to implement, and include examples of how the feature is used. This section can start out light before the prototyping phase but should get into specifics and corner-cases as the feature is iteratively designed and implemented.
## Drawbacks
[drawbacks]: #drawbacks
Why should we *not* do this?
## Alternatives
[alternatives]: #alternatives
What other designs have been considered? What is the impact of not doing this?
## Unresolved questions
[unresolved]: #unresolved-questions
What parts of the design are still undecided?
2017-01-27 20:02:27 +01:00
## Design meetings
Link to design notes that affect this proposal, and describe in one sentence for each what changes they led to.