Skip to content

Commit 67c9123

Browse files
authored
Merge pull request #867 from wagenet/advancement-workflow-docs
Advancement workflow docs
2 parents a98f0af + 0c2ec61 commit 67c9123

File tree

3 files changed

+35
-19
lines changed

3 files changed

+35
-19
lines changed

.github/READTHIS.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ This has various checks to ensure new the RFC has correct metadata, filename, et
1212
This should be tested when updating actions/find-added-or-modified-rfcs or any of
1313
the actions used within that action. See [testing](#testing).
1414

15-
Test the following:
15+
#### Testing Steps
16+
1617
- [ ] Adding a new RFC. A new pull request should be opened with a new RFC, the
1718
first job should correctly determine that an RFC has been added and the other
1819
jobs should run.
@@ -34,7 +35,8 @@ whether the pull request adds a new RFC. If it does, it labels the pull request
3435
This should be tested when updating actions/find-added-or-modified-rfcs or any of
3536
the actions used within that action. See [testing](#testing).
3637

37-
Test the following:
38+
#### Testing Steps
39+
3840
- [ ] Adding a new RFC. A new pull request should be opened with a new RFC, the
3941
first job should correctly determine that an RFC has been added and the other
4042
jobs should run. The label `S-Proposed` should be added.
@@ -57,7 +59,8 @@ If an RFC stage was modified, this triggers the open-advancement-pr.yml workflow
5759
This should be tested when updating actions/find-added-or-modified-rfcs or any of
5860
the actions used within that action. See [testing](#testing).
5961

60-
Test the following:
62+
#### Testing Steps
63+
6164
- [ ] Adding a new RFC. Merging a pull request that adds an RFC should open a
6265
pull request to advance to the next stage using the correct template.
6366
- [ ] Updating an RFC stage. Merging a pull request that modifies an existing RFC's
@@ -74,7 +77,15 @@ This workflow runs on workflow_dispatch and can be triggered from the GitHub UI.
7477
It takes a path to an RFC and will open a PR to advance it to the next stage, if
7578
applicable.
7679

77-
Test the following:
80+
RFCs that already existed before the implementation of
81+
[Staged RFCs](https://github.com/emberjs/rfcs/blob/master/text/0617-rfc-stages.md)
82+
did not get advancement PRs to their next stage. To create an advancement PR you
83+
can manually run the workflow from the Github UI.
84+
85+
![Screenshot of the Github UI for manually triggering a workflow](./doc-assets/advance-rfc.png)
86+
87+
#### Testing Steps
88+
7889
- [ ] In the UI, on this workflow, trigger with a path of an existing RFC. A pull
7990
request should be opened to advance the RFC to the next stage.
8091
- [ ] In the UI, on this workflow, trigger with a path of an existing RFC at the

.github/doc-assets/advance-rfc.png

107 KB
Loading

README.md

+20-15
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The process is intended to provide a consistent and controlled path for new
1414
features and changes to enter the framework. RFCs can be created by any member
1515
of the community.
1616

17-
---
17+
---
1818
## Quick links for Pull Requests for proposed and advancing RFCs
1919
[Quick links for Pull Requests for proposed and advancing RFCs]: #quick-links-for-pull-requests-for-proposed-and-advancing-rfcs
2020

@@ -82,7 +82,7 @@ If that period is successful, with no new unaddressed concerns raised, the RFC
8282
is merged and is now in the [Accepted] stage.
8383

8484
An RFC that does not achieve consensus to be accepted may enter a
85-
[Final Comment Period](#final-comment-periods-fcp) to move the RFC to the
85+
[Final Comment Period](#final-comment-periods-fcp) to move the RFC to the
8686
[Closed] stage.
8787

8888
### Merged Proposals
@@ -276,30 +276,30 @@ Ember.
276276
Following the RFC repository is the best way to keep up with the proposed
277277
changes to Ember and with the implementation of accepted changes.
278278

279-
Watching the repository will alert you to any newly created RFCs. Setting up
280-
notifications on a particular pull request will help you follow the progress of
279+
Watching the repository will alert you to any newly created RFCs. Setting up
280+
notifications on a particular pull request will help you follow the progress of
281281
that RFC.
282282

283283
RFCs in [Final Comment Periods](#final-comment-periods-fcp) are labeled with
284284
[Final Comment Period](https://github.com/emberjs/rfcs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+label%3A%22Final+Comment+Period%22)
285285
and are announced on the [Ember twitter account](https://twitter.com/emberjs).
286286

287-
[Quick links](#quick-links-for-pull-requests-for-proposed-and-advancing-rfcs)
287+
[Quick links](#quick-links-for-pull-requests-for-proposed-and-advancing-rfcs)
288288
are provided at the top of the README to help you review what you are interested in.
289289

290290

291291
## Commenting on an RFC
292292
[Commenting on an RFC]: #commenting-on-an-rfc
293293

294-
Comments are the very heart of the RFC process. Comments are the primary way community
295-
members and core team members can provide feedback and collaborate on the design
296-
of a feature.
294+
Comments are the very heart of the RFC process. Comments are the primary way community
295+
members and core team members can provide feedback and collaborate on the design
296+
of a feature.
297297

298-
Comments should also be used to ensure the author has completed the RFC template
299-
and addressed implications of the feature across the Ember project, including
300-
documentation, addons, and tooling.
298+
Comments should also be used to ensure the author has completed the RFC template
299+
and addressed implications of the feature across the Ember project, including
300+
documentation, addons, and tooling.
301301

302-
Comments should be constructive and respectful, following our
302+
Comments should be constructive and respectful, following our
303303
[Community Guidelines](http://emberjs.com/guidelines/).
304304

305305
## Creating an RFC
@@ -398,15 +398,15 @@ shepherding its progress. [Read more about the Champion's job](#champion-respons
398398
## Implementing an RFC
399399
[Implementing an RFC]: #implementing-an-rfc
400400

401-
Coordination and tracking of implementation of an RFC is done primarily on the
401+
Coordination and tracking of implementation of an RFC is done primarily on the
402402
pull request to advance the RFC to the [Ready for Release] stage.
403403

404404
The author of an RFC is not obligated to implement it. Of course, the
405405
RFC author (like any other developer) is welcome to work on the implementation.
406406

407407
If you are interested in working on the implementation for an [Accepted]
408408
RFC, but cannot determine if someone else is already working on it,
409-
please ask (e.g. by leaving a comment on the pull request to advance the RFC to
409+
please ask (e.g. by leaving a comment on the pull request to advance the RFC to
410410
the [Ready for Release] stage).
411411

412412
### Editing merged RFCs
@@ -423,7 +423,7 @@ about this feature." This note is not intended to be updated across time.
423423
- Updating any part of the RFC prose, in order to keep a written record of the
424424
changes and rationale.
425425

426-
Major changes should have a new RFC. The old RFC is moved to the [Discontinued]
426+
Major changes should have a new RFC. The old RFC is moved to the [Discontinued]
427427
stage when the replacement is merged.
428428

429429
## Reference
@@ -521,6 +521,11 @@ champion at any time.
521521
- [ ] Prepare for advancing the RFC to the next stage if applicable (e.g.
522522
opening a placeholder PR)
523523

524+
For RFCs opened before the implementation of
525+
[Staged RFCs](https://github.com/emberjs/rfcs/blob/master/text/0617-rfc-stages.md)
526+
did not get advancement PRs to their next stage. See the
527+
[automations docs](https://github.com/emberjs/rfcs/blob/master/.github/READTHIS.md#trigger-opening-advancement-pryml) for instructions on how to trigger the advancement workflow.
528+
524529
#### Move to FCP to Close
525530
- [ ] Achieve consensus to move to "FCP to Close" from relevant core teams
526531
- [ ] Comment in the RFC to explain the decision

0 commit comments

Comments
 (0)