Skip to content

Commit 01de7cd

Browse files
author
James Munns
committed
Almost done!
1 parent bc9ce49 commit 01de7cd

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

0000-project-template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Metadata
2+
3+
These items should be filled in on accepting of this task:
4+
5+
* (task shepherd)
6+
* (who are contributors to this task?)
7+
* (link to the external repository/fork/branch where work on this task is occuring)
8+
9+
# Background
10+
11+
* What is the current problem or shortcoming motivating this task?
12+
* What is the relevance to this project?
13+
14+
# Suggested Task
15+
16+
* What is the desired outcome to address this problem/shortcoming?
17+
* What is necessary to achieve this outcome?

rfcs/0000-shepherding.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This RFC proposes a structure for proposing, selecting, and tracking progress on
2121

2222
For a general background on the concept of Shepherding, refer to the blog posts by [James Munns] and [Niko Matsakis].
2323

24-
[James Munns]: #
24+
[James Munns]: https://jamesmunns.com/blog/shepherding-3-1/
2525
[Niko Matsakis]: http://smallcultfollowing.com/babysteps/blog/2019/09/11/aic-shepherds-3-0/
2626

2727
# Detailed design
@@ -31,11 +31,9 @@ This RFC covers four main stages of how we tackle large scale work, referred to
3131

3232
## Proposal
3333

34-
Anyone may propose a large scale project to be worked on. Projects are proposed by opening an issue that is tagged with the `project` tag on the [Issue Tracker].
34+
Anyone may propose a large scale project to be worked on. Projects are proposed by opening an PR that copies the project template from `0000-project-template.md` to `projects/in-progress/0000-your-project-name.md`.
3535

36-
[Issue Tracker]: https://github.com/rust-embedded/wg/issues
37-
38-
All proposals should contain the following information:
36+
All proposals should contain the following information in the template file:
3937

4038
1. What is the current problem/shortcoming?
4139
2. What is the relevance to the Rust Embedded Ecosystem?
@@ -48,17 +46,6 @@ Once a potential sponsor has been found, the project may be selected.
4846

4947
## Selection
5048

51-
In order to move an issue from "proposed" to "selected", the proposer and sponsor should open a PR to add the project to the `projects/` folder in this repo. Items in this folder should be named `0000-project-name.md`, and should contain the following information:
52-
53-
1. All contents from the proposal
54-
* Original problem
55-
* Relevance
56-
* Desired Outcome
57-
* What will be done?
58-
2. Who is the WG sponsor for this issue?
59-
3. Who else is working on this issue?
60-
4. If relevant, a link to the repository where work on this project is being done
61-
6249
A project does not require full WG approval to be selected, only the sponsorship of one or more WG members. This member will be expected to provide status updates at the weekly Matrix meeting on the status of this project. If the WG member is unable to attend, they can delegate this responsibility as necessary.
6350

6451
A project moves to the tracking state once the PR adding the project to the `projects/` folder has been approved by the sponsoring WG member.
@@ -83,13 +70,13 @@ Once a project has been completed, the WG sponsor is no longer required to provi
8370

8471
### Finished
8572

86-
If the work has completed successfully by meeting the current or revised goals, and does not require ongoing focus, this can be signified by submitting a PR to move the project file from `projects/` to `projects/completed/`. This move only requires the approval of the sponsoring WG member.
73+
If the work has completed successfully by meeting the current or revised goals, and does not require ongoing focus, this can be signified by submitting a PR to move the project file from `projects/in-progress/` to `projects/completed/`. This move only requires the approval of the sponsoring WG member.
8774

8875
It is recommended to add a section to the project file summarizing the outcome of the project, and what was achieved.
8976

9077
### On-Hold
9178

92-
If the work need to be put on hold due to availability or technical reasons, this can be signified by submitting a PR to move the project file from `projects/` to `projects/on-hold/`. This move only requires the approval of the sponsoring WG member.
79+
If the work need to be put on hold due to availability or technical reasons, this can be signified by submitting a PR to move the project file from `projects/in-progress/` to `projects/on-hold/`. This move only requires the approval of the sponsoring WG member.
9380

9481
If a project is not expected to make progress, or hasn't made progress, for one month or more it is recommended that it be moved to the on-hold state.
9582

@@ -128,4 +115,4 @@ What other designs have been considered? What is the impact of not doing this?
128115
# Unresolved questions
129116
[unresolved]: #unresolved-questions
130117

131-
What parts of the design are still TBD?
118+
None known at this time

0 commit comments

Comments
 (0)