Skip to content

Commit cc932e7

Browse files
author
Niko Matsakis
committed
document fcp command
1 parent fb69219 commit cc932e7

File tree

4 files changed

+48
-1
lines changed

4 files changed

+48
-1
lines changed

src/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,7 @@
4848
* [Overall setup](./admin/setup.md)
4949
* [Mdbook plugin details](./admin/mdbook_plugin.md)
5050
* [`cargo rpg` command reference](./admin/commands.md)
51+
* [`rfc`, export RFC text](./admin/rfc_command.md)
52+
* [`fcp`, create the FCP merge comment](./admin/fcp_command.md)
5153
* [`issues`, creating tracking issues](./admin/issues.md)
5254
* [`updates`, create monthly blog post summary](./admin/updates.md)

src/admin/fcp_command.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# `fcp`, create the FCP merge comment
2+
3+
The `cargo rpg fcp` command creates an FCP comment, since the format for the project goals RFC is distinct from other RFCs.
4+
5+
To use, simply invoke the command with the directory for the goal period, e.g., something like this:
6+
7+
```
8+
> cargo rpg rfc src/2025h1
9+
```
10+
11+
This will emit a comment to stdout that includes the name of each team which has registered asks along with checkboxes for each individual on that team.

src/admin/prepare_rfc.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
# foo
1+
# Preparing the RFC
2+
3+
## Review with teams
4+
5+
Before opening the RFC it is best to review its current state with teams that have large number of goals. You want there to be as little surprise as possible once the RFC itself is opened, as it will be more annoying to make changes.
6+
7+
Encourage teams to read over the list of asks assigned to them and answer questions like
8+
9+
* Are there any goals that you are not aligned with? (i.e., work that you do not think should happen, or do not think should happen now)
10+
* Is there important work not represented here? Should that work have a project goal?
11+
* Is the team capable of following through on the total asks, or will that exceed team capacity?
12+
* If [flagship goals](../about/flagship_goals.md) have been decided, are there any concerns with those goals? Any suggestions for changes or alternatives?
13+
14+
## Select flagship goals
15+
16+
[Flagship goals](../about/flagship_goals.md) represent the 2-3 items that will be highlighted and will be the focus of external communication. The project goal team is responsible for selecting flagship goals. The criteria for flagship goals is described in the [About page](../about//flagship_goals.md). Because flagship goals generally take longer than 6 months to complete, most flagship goals are continuations from previous sessions, but as those goals get closer to completion, it may be good to shift the messaging towards a fresh focus.
17+
18+
## Creating the RFC
19+
20+
Run [`cargo rpg rfc`](./rfc_command.md) to export the RFC text in a format suitable for adding into the RFCs repository.
21+
22+
## Beginning Final Comment Period
23+
24+
Unlike ordinary RFCs, project goal RFCs are not chosen by any one team. Instead we craft a comment with the names of all project members. The leads of each team at minimum are required to check their box, though obviously the more boxes the better. You can craft this comment with the [`cargo rpg fcp`](./fcp_command.md) command.

src/admin/rfc_command.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# `rfc`, export RFC text
2+
3+
The `cargo rpg rfc` command exports RFC text suitable for inclusion in the rust-lang/rfcs repository. It is intended for use when [preparing the RFC](./prepare_rfc.md) at the start of a goal period.
4+
5+
To use, simply invoke the command with the directory for the goal period, e.g., something like this:
6+
7+
```
8+
> cargo rpg rfc src/2025h1
9+
```
10+
11+
This will read the README.md file and dump a version to stdout that can be copy-and-paste. This version will have URLs adjusted to point at the rust-lang/rust-project-goals repository and other cosmetic changes.

0 commit comments

Comments
 (0)