Skip to content

Commit 8545974

Browse files
authored
cfp command (#310)
* fix toml * create a cfp command (authored with AI assistance) * update the title of the rfc * create a 2025H2 RFC * author unit tests and fix a bug that was found * say 'start of' to 'end of' * additional test
1 parent c8ecee9 commit 8545974

File tree

11 files changed

+763
-9
lines changed

11 files changed

+763
-9
lines changed

book.toml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ title = "Rust Project Goals"
77

88
[preprocessor.goals]
99
command = "cargo run -p mdbook-goals --"
10+
ignore_users = [
11+
"@triagebot",
12+
]
1013

1114
[preprocessor.goals.links]
1215
"Help wanted" = "https://img.shields.io/badge/Help%20wanted-yellow"
@@ -23,10 +26,6 @@ command = "cargo run -p mdbook-goals --"
2326
[preprocessor.goals.users]
2427
"@Nadrieril" = "@Nadrieril"
2528

26-
preprocessor.goals.ignore_users = [
27-
"@triagebot",
28-
]
29-
3029

3130
[output.html]
3231
git-repository-url = "https://github.com/rust-lang/rust-project-goals"

crates/rust-project-goals-cli/src/cfp.rs

Lines changed: 533 additions & 0 deletions
Large diffs are not rendered by default.

crates/rust-project-goals-cli/src/main.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use rust_project_goals_llm::UpdateArgs;
66
use std::path::PathBuf;
77
use walkdir::WalkDir;
88

9+
mod cfp;
910
mod generate_json;
1011
mod rfc;
1112
mod team_repo;
@@ -29,6 +30,20 @@ enum Command {
2930

3031
/// Print the RFC text to stdout
3132
RFC { path: PathBuf },
33+
34+
/// Set up a new Call For Proposals (CFP) period
35+
CFP {
36+
/// Timeframe for the new CFP period (e.g., 2025h1)
37+
timeframe: String,
38+
39+
/// Force overwrite without asking for confirmation
40+
#[arg(short = 'f', long = "force")]
41+
force: bool,
42+
43+
/// Dry run - don't make any changes, just show what would be done
44+
#[arg(short = 'n', long = "dry-run")]
45+
dry_run: bool,
46+
},
3247

3348
/// Use `gh` CLI tool to create issues on the rust-lang/rust-project-goals repository
3449
Issues {
@@ -86,6 +101,10 @@ fn main() -> anyhow::Result<()> {
86101
rfc::generate_comment(&path)?;
87102
}
88103

104+
Command::CFP { timeframe, force, dry_run } => {
105+
cfp::create_cfp(timeframe, *force, *dry_run)?;
106+
}
107+
89108
Command::Check {} => {
90109
check()?;
91110
}

src/2025h2/README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Rust project goals 2025h2
2+
3+
4+
## Summary
5+
6+
*![Status: Accepting goal proposals](https://img.shields.io/badge/Status-Accepting%20goal%20proposals-yellow) We are in the process of assembling the goal slate.*
7+
8+
This is a draft for the eventual RFC proposing the 2025h2 goals.
9+
10+
## Motivation
11+
12+
The 2025h2 goal slate consists of <!-- #GOALS --> project goals, of which we have selected (TBD) as **flagship goals**. Flagship goals represent the goals expected to have the broadest overall impact.
13+
14+
### How the goal process works
15+
16+
**Project goals** are proposed bottom-up by a **point of contact**, somebody who is willing to commit resources (time, money, leadership) to seeing the work get done. The point of contact identifies the problem they want to address and sketches the solution of how they want to do so. They also identify the support they will need from the Rust teams (typically things like review bandwidth or feedback on RFCs). Teams then read the goals and provide feedback. If the goal is approved, teams are committing to support the point of contact in their work.
17+
18+
Project goals can vary in scope from an internal refactoring that affects only one team to a larger cross-cutting initiative. No matter its scope, accepting a goal should never be interpreted as a promise that the team will make any future decision (e.g., accepting an RFC that has yet to be written). Rather, it is a promise that the team are aligned on the contents of the goal thus far (including the design axioms and other notes) and will prioritize giving feedback and support as needed.
19+
20+
Of the proposed goals, a small subset are selected by the roadmap owner as **flagship goals**. Flagship goals are chosen for their high impact (many Rust users will be impacted) and their shovel-ready nature (the org is well-aligned around a concrete plan). Flagship goals are the ones that will feature most prominently in our public messaging and which should be prioritized by Rust teams where needed.
21+
22+
### Rust’s mission
23+
24+
Our goals are selected to further Rust's mission of **empowering everyone to build reliable and efficient software**. Rust targets programs that prioritize
25+
26+
* reliability and robustness;
27+
* performance, memory usage, and resource consumption; and
28+
* long-term maintenance and extensibility.
29+
30+
We consider "any two out of the three" as the right heuristic for projects where Rust is a strong contender or possibly the best option.
31+
32+
### Axioms for selecting goals
33+
34+
We believe that...
35+
36+
* **Rust must deliver on its promise of peak performance and high reliability.** Rust’s maximum advantage is in applications that require peak performance or low-level systems capabilities. We must continue to innovate and support those areas above all.
37+
* **Rust's goals require high productivity and ergonomics.** Being attentive to ergonomics broadens Rust impact by making it more appealing for projects that value reliability and maintenance but which don't have strict performance requirements.
38+
* **Slow and steady wins the race.** For this first round of goals, we want a small set that can be completed without undue stress. As the Rust open source org continues to grow, the set of goals can grow in size.
39+
40+
## Guide-level explanation
41+
[guide-level-explanation]: #guide-level-explanation
42+
43+
### Flagship goals
44+
45+
The flagship goals proposed for this roadmap are as follows:
46+
47+
(TBD)
48+
49+
#### Why these particular flagship goals?
50+
51+
(TBD--typically one paragraph per goal)
52+
53+
### Project goals
54+
55+
The full slate of project goals are as follows. These goals all have identified points of contact who will drive the work forward as well as a viable work plan. The goals include asks from the listed Rust teams, which are cataloged in the [reference-level explanation](#reference-level-explanation) section below.
56+
57+
**Invited goals.** Some goals of the goals below are "invited goals", meaning that for that goal to happen we need someone to step up and serve as a point of contact. To find the invited goals, look for the ![Help wanted][] badge in the table below. Invited goals have reserved capacity for teams and a mentor, so if you are someone looking to help Rust progress, they are a great way to get involved.
58+
59+
<!-- GOALS -->
60+
61+
# Reference-level explanation
62+
[reference-level-explanation]: #reference-level-explanation
63+
64+
The following table highlights the asks from each affected team.
65+
The "owner" in the column is the person expecting to do the design/implementation work that the team will be approving.
66+
67+
<!-- TEAM ASKS -->
68+
69+
### Definitions
70+
71+
Definitions for terms used above:
72+
73+
* *Author RFC* and *Implementation* means actually writing the code, document, whatever.
74+
* *Design meeting* means holding a synchronous meeting to review a proposal and provide feedback (no decision expected).
75+
* *RFC decisions* means reviewing an RFC and deciding whether to accept.
76+
* *Org decisions* means reaching a decision on an organizational or policy matter.
77+
* *Secondary review* of an RFC means that the team is "tangentially" involved in the RFC and should be expected to briefly review.
78+
* *Stabilizations* means reviewing a stabilization and report and deciding whether to stabilize.
79+
* *Standard reviews* refers to reviews for PRs against the repository; these PRs are not expected to be unduly large or complicated.
80+
* Other kinds of decisions:
81+
* [Lang team experiments](https://lang-team.rust-lang.org/how_to/experiment.html) are used to add nightly features that do not yet have an RFC. They are limited to trusted contributors and are used to resolve design details such that an RFC can be written.
82+
* Compiler [Major Change Proposal (MCP)](https://forge.rust-lang.org/compiler/mcp.html) is used to propose a 'larger than average' change and get feedback from the compiler team.
83+
* Library [API Change Proposal (ACP)](https://std-dev-guide.rust-lang.org/development/feature-lifecycle.html) describes a change to the standard library.
84+
85+
[AGS]: ./Project-goal-slate.md
86+
[AMF]: ./a-mir-formality.md
87+
[Async]: ./async.md
88+
[ATPIT]: ./ATPIT.md
89+
[CS]: ./cargo-script.md
90+
[CT]: ./const-traits.md
91+
[ERC]: ./ergonomic-rc.md
92+
[MGCA]: ./min_generic_const_arguments.md
93+
[NBNLB]: ./Polonius.md
94+
[NGS]: ./next-solver.md
95+
[PET]: ./Patterns-of-empty-types.md
96+
[PGC]: ./pubgrub-in-cargo.md
97+
[RFL]: ./rfl_stable.md
98+
[SBS]: ./sandboxed-build-script.md
99+
[YKR]: ./yank-crates-with-a-reason.md
100+
[SC]: ./Rust-for-SciComp.md
101+
[OC]: ./optimize-clippy.md
102+
103+
<!-- Github usernames -->

src/2025h2/goals.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Goals
2+
3+
4+
This page lists the <!-- #GOALS --> project goals **proposed** for 2025h2.
5+
6+
> Just because a goal is listed on this list does not mean the goal has been accepted.
7+
> The owner of the goal process makes the final decisions on which goals to include
8+
> and prepares an RFC to ask approval from the teams.
9+
10+
## Flagship goals
11+
12+
Flagship goals represent the goals expected to have the broadest overall impact.
13+
14+
<!-- FLAGSHIP GOALS -->
15+
16+
## Other goals
17+
18+
These are the other proposed goals.
19+
20+
**Invited goals.** Some goals of the goals below are "invited goals", meaning that for that goal to happen we need someone to step up and serve as a point of contact. To find the invited goals, look for the ![Help wanted][] badge in the table below. Invited goals have reserved capacity for teams and a mentor, so if you are someone looking to help Rust progress, they are a great way to get involved.
21+
22+
<!-- OTHER GOALS -->

src/2025h2/not_accepted.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Not accepted
2+
3+
4+
This section contains goals that were proposed but ultimately not accepted, either for want of resources or consensus. In many cases, narrower versions of these goals were proposed instead.
5+
6+
<!-- GOALS NOT ACCEPTED -->

src/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ The 2025H1 goal period runs from Jan 1 to Jun 30. We have identified three flags
2222

2323
[The full list of 2025H1 goals is available here.](./2025h1/goals.md) We author monthly blog posts about our overall status, but you can also follow the tracking issue for a [particular goal](./2025h1/goals.md) to get updates specific to that goal.
2424

25-
## Next goal period (2025h2)
2625

27-
Discussion about goals for the next goal period will begin in May.
26+
## Next goal period (2025H2)
27+
28+
The next goal period will be 2025H2, running from July 1 to December 30. We are currently in the process of assembling goals. [Click here](./2025h2/goals.md) to see the current list. If you'd like to propose a goal, [instructions can be found here](./how_to/propose_a_goal.md).
2829

2930
## About the process
3031

src/SUMMARY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010

1111
# ⏳ 2025H2 goal process
1212

13-
- [Not yet started]()
13+
- [Overview](./2025h2/README.md)
14+
- [Proposed goals](./2025h2/goals.md)
15+
- [Goals not accepted](./2025h2/not_accepted.md)
1416

1517
# 📖 Learn about
1618

src/admin/cfp.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,50 @@ Each goal milestone corresponds to six months, designated in the format YYYYhN,
55
* For an H1 season, start around mid October of the year before.
66
* For an H2 season, start around mid April of the year before.
77

8-
This is the checklist of steps to starting accepting goal proposals:
8+
## Using the automated setup command
9+
10+
The easiest way to set up a new Call For Proposals (CFP) period is to use the `cargo rpg cfp` command. This command automates the process of creating the necessary directory structure, copying template files, and updating both the SUMMARY.md and README.md files.
11+
12+
```bash
13+
# Basic usage
14+
cargo rpg cfp 2025h2
15+
16+
# Force overwrite without asking for confirmation
17+
cargo rpg cfp 2025h2 --force
18+
19+
# Dry run - don't make any changes, just show what would be done
20+
cargo rpg cfp 2025h2 --dry-run
21+
```
22+
23+
The command will:
24+
1. Create a new directory for the specified timeframe (e.g., `src/2025h2/`)
25+
2. Copy and process template files from `src/admin/samples/` to the new directory
26+
3. Update the `SUMMARY.md` file to include the new timeframe section
27+
4. Update the main `README.md` with information about the new timeframe
28+
29+
## Manual steps required
30+
31+
After running the `cargo rpg cfp` command, there are still important manual steps that need to be completed:
32+
33+
### 1. Prepare and publish a blog post
34+
35+
You need to prepare a Call For Proposals blog post on the [Inside Rust] blog:
36+
* Use [this sample](./samples/cfp.md) as a starting point
37+
* Copy the sample to the `blog.rust-lang.org` repository as a new post
38+
* Replace placeholders like `YYYYHN` with the actual timeframe (e.g., `2025H2`)
39+
* We use Inside Rust and not the Main blog because the target audience is would-be Rust contributors and maintainers
40+
41+
### 2. Email the mailing list
42+
43+
Send an email to the `all@rust-lang.org` mailing list to announce the Call For Proposals:
44+
* Include a link to the blog post
45+
* Summarize the key dates and process
46+
* Encourage team participation and feedback
47+
* This step is crucial for ensuring all Rust team members are aware of the upcoming goal period
48+
49+
## Manual setup checklist
50+
51+
If you prefer to set up the CFP manually, or need to customize the process beyond what the automated command provides, here's a checklist of steps:
952

1053
* [ ] Prepare a Call For Proposals blog post on the [Inside Rust] blog based on [this sample](./samples/cfp.md).
1154
* We use Inside Rust and not the Main blog because the target audience is would-be Rust contributors and maintainers.

src/admin/commands.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,29 @@
33
The `cargo rpg` command is a CLI for manipulating and checking project goals. This section provides a reference describing (some of) the ability commands. You can also try `cargo rpg --help` to get a summary.
44

55
Note that this relies on the [`gh` client](https://github.com/cli/cli), which needs to be installed and configured with a token (for example using `gh auth login`).
6+
7+
## Available Commands
8+
9+
### `cargo rpg cfp`
10+
11+
Sets up a new Call For Proposals (CFP) period. This command automates the process of creating the necessary directory structure, copying template files, and updating both the SUMMARY.md and README.md files.
12+
13+
```bash
14+
# Basic usage
15+
cargo rpg cfp <timeframe>
16+
17+
# Options
18+
cargo rpg cfp <timeframe> --force # Force overwrite without asking for confirmation
19+
cargo rpg cfp <timeframe> --dry-run # Don't make any changes, just show what would be done
20+
```
21+
22+
Example:
23+
```bash
24+
cargo rpg cfp 2025h2
25+
```
26+
27+
Note that after running this command, you'll still need to manually:
28+
1. Prepare and publish a blog post on the Inside Rust blog
29+
2. Send an email to the `all@rust-lang.org` mailing list
30+
31+
For more details, see the [Call for proposals](./cfp.md) documentation.

src/admin/samples/rfc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sample RFC
1+
# Rust project goals YYYYHN
22

33
> **NOTE:** This is a sample RFC you can use as a starting point.
44
> To begin a new goal season (e.g., 2222H1), do the following:

0 commit comments

Comments
 (0)