Skip to content

Commit 44dd8c2

Browse files
authored
Merge pull request swiftlang#497 from bjlanier/proposal-format-cleanup
Update proposal template and documented states to standardize current usage.
2 parents 7fcba97 + 18333c3 commit 44dd8c2

File tree

2 files changed

+31
-14
lines changed

2 files changed

+31
-14
lines changed

0000-template.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
# Feature name
22

33
* Proposal: [SE-NNNN](NNNN-filename.md)
4-
* Author: [Swift Developer](https://github.com/swiftdev)
4+
* Authors: [Author 1](https://github.com/swiftdev), [Author 2](https://github.com/swiftdev)
5+
* Review Manager: TBD
56
* Status: **Awaiting review**
6-
* Review manager: TBD
7+
8+
*During the review process, add the following fields as needed:*
9+
10+
* Decision Notes: [Rationale](https://lists.swift.org/pipermail/swift-evolution/), [Additional Commentary](https://lists.swift.org/pipermail/swift-evolution/)
11+
* Bugs: [SR-NNNN](https://bugs.swift.org/browse/SR-NNNN), [SR-MMMM](https://bugs.swift.org/browse/SR-MMMM)
12+
* Previous Revision: [1](https://github.com/apple/swift-evolution/blob/...commit-ID.../proposals/NNNN-filename.md)
13+
* Previous Proposal: [SE-XXXX](XXXX-filename.md)
714

815
## Introduction
916

1017
A short description of what the feature is. Try to keep it to a
1118
single-paragraph "elevator pitch" so the reader understands what
12-
problem this proposal is addressing.
19+
problem this proposal is addressing.
1320

1421
Swift-evolution thread: [Discussion thread topic for that proposal](https://lists.swift.org/pipermail/swift-evolution/)
1522

process.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,23 +82,33 @@ repository][swift-evolution-repo] to reflect that decision.
8282
## Proposal states
8383
A given proposal can be in one of several states:
8484

85-
* **Awaiting review**: the proposal is awaiting review. Once known,
85+
* **Awaiting review**: The proposal is awaiting review. Once known,
8686
the dates for the actual review will be placed in the proposal
8787
document and updated in the [list of proposals](proposals.xml). When the
8888
review period begins, the review manager will update the state to
89-
*under review*.
90-
* **Under review**: the proposal is undergoing public review on the [swift-evolution mailing list][swift-evolution-mailing-list].
91-
* **Under revision**: the proposal is undergoing revision by the
92-
author(s) based on feedback from the review.
93-
* **Deferred**: consideration of the proposal has been deferred
89+
*Active review*.
90+
* **Scheduled for review (MONTH DAY...MONTH DAY)**: The public review of the proposal
91+
on the [swift-evolution mailing list][swift-evolution-mailing-list]
92+
has been scheduled for the specified date range.
93+
* **Active review (MONTH DAY...MONTH DAY)**: The proposal is undergoing public review
94+
on the [swift-evolution mailing list][swift-evolution-mailing-list].
95+
The review will continue through the specified date range.
96+
* **Returned for revision**: The proposal has been returned from review
97+
for additional revision to the current draft.
98+
* **Withdrawn**: The proposal has been withdrawn by the original submitter.
99+
* **Deferred**: Consideration of the proposal has been deferred
94100
because it does not meet the [goals of the upcoming major Swift
95101
release](README.md). Deferred proposals will be reconsidered when
96102
scoping the next major Swift release.
97-
* **Accepted**: the proposal has been accepted and is either awaiting
98-
implementation or is actively being implemented. Once a proposal
99-
enters the "accepted" state, it gets placed into its [target Swift
100-
release](README.md).
101-
* **Rejected**: the proposal has been considered and rejected.
103+
* **Accepted**: The proposal has been accepted and is either awaiting
104+
implementation or is actively being implemented.
105+
* **Accepted with revisions**: The proposal has been accepted,
106+
contingent upon the inclusion of one or more revisions.
107+
* **Rejected**: The proposal has been considered and rejected.
108+
* **Implemented (Swift VERSION)**: The proposal has been implemented.
109+
Append the version number in parentheses—for example: Implemented (Swift 2.2).
110+
If the proposal's implementation spans multiple version numbers,
111+
write the version number for which the implementation will be complete.
102112

103113
[swift-evolution-repo]: https://github.com/apple/swift-evolution "Swift evolution repository"
104114
[swift-evolution-mailing-list]: https://swift.org/community/#swift-evolution "Swift evolution mailing list"

0 commit comments

Comments
 (0)