Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Instructions for rust-project-goals work
# Instructions for goals work

This file provides instructions for contributing to the `rust-project-goals` repository. It is intended to be self-contained: everything needed to work effectively in this repository is documented here or cited with a precise path.
This file provides instructions for contributing to the `goals` repository. It is intended to be self-contained: everything needed to work effectively in this repository is documented here or cited with a precise path.

## Repository overview

This repository hosts the Rust project's **goal proposals** -- a bottom-up process where contributors propose goals, Rust teams review them, and accepted goals are tracked to completion. The repository is published as an mdBook site at <https://rust-lang.github.io/rust-project-goals/>.
This repository hosts the Rust project's **goal proposals** -- a bottom-up process where contributors propose goals, Rust teams review them, and accepted goals are tracked to completion. The repository is published as an mdBook site at <https://rust-lang.github.io/goals/>.

There are two kinds of content:

Expand Down Expand Up @@ -83,7 +83,7 @@ Immediately after the title, a two-column markdown table with the header `| Meta
| `Point of contact` | Yes | Parsed | Single GitHub `@username` |
| `Status` | Yes | Parsed | `Proposed`, `Invited`, `Accepted`, `Proposed for mentorship`, or `Not accepted` |
| `Short title` | No | Parsed | Alternate short title for tables; defaults to the `#` heading |
| `Tracking issue` | Note [1] | Parsed | Must contain `rust-project-goals#NNN` if present |
| `Tracking issue` | Note [1] | Parsed | Must contain `rust-lang/goals#NNN` if present |
| `Other tracking issues` | No | Conventional | For issues in other repos; use `org/repo#NNN` format |
| `Zulip channel` | No | Conventional | Link to Zulip stream |
| `Help wanted` | No | Conventional | Informational |
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# rust-project-goals
# Rust Project Goals

Check out the [website](https://rust-lang.github.io/goals/).
6 changes: 3 additions & 3 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ ignore_users = [


[output.html]
git-repository-url = "https://github.com/rust-lang/rust-project-goals"
edit-url-template = "https://github.com/rust-lang/rust-project-goals/edit/main/{path}"
site-url = "/rust-project-goals/"
git-repository-url = "https://github.com/rust-lang/goals"
edit-url-template = "https://github.com/rust-lang/goals/edit/main/{path}"
site-url = "/goals/"
additional-js = ["mermaid.min.js", "mermaid-init.js"]

[output.html.fold]
Expand Down
13 changes: 5 additions & 8 deletions crates/mdbook-goals/src/goal_preprocessor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -950,8 +950,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
"🌐 Loading issues from GitHub API for milestone: {}",
milestone
);
let repository =
rust_project_goals::gh::issue_id::Repository::new("rust-lang", "rust-project-goals");
let repository = rust_project_goals::gh::issue_id::Repository::new("rust-lang", "goals");
let issues =
rust_project_goals::gh::issues::list_issues_in_milestone(&repository, milestone)
.map_err(|e| {
Expand Down Expand Up @@ -1272,9 +1271,8 @@ impl<'c> GoalPreprocessorWithContext<'c> {
}
.ok_or_else(|| anyhow::anyhow!("Invalid end date calculation for {}-{:02}", year, month))?;

// Get repository from context - assuming rust-lang/rust-project-goals as default
let repository =
rust_project_goals::gh::issue_id::Repository::new("rust-lang", "rust-project-goals");
// Get repository from context - assuming rust-lang/goals as default
let repository = rust_project_goals::gh::issue_id::Repository::new("rust-lang", "goals");

// Use cached issues for this milestone
let issues = self.get_or_load_milestone_issues(milestone)?;
Expand Down Expand Up @@ -1309,9 +1307,8 @@ impl<'c> GoalPreprocessorWithContext<'c> {
team_name, milestone
);

// Get repository from context - assuming rust-lang/rust-project-goals as default
let repository =
rust_project_goals::gh::issue_id::Repository::new("rust-lang", "rust-project-goals");
// Get repository from context - assuming rust-lang/goals as default
let repository = rust_project_goals::gh::issue_id::Repository::new("rust-lang", "goals");

// Use cached issues for this milestone
let issues = self.get_or_load_milestone_issues(milestone)?;
Expand Down
4 changes: 2 additions & 2 deletions crates/rust-project-goals-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ struct Opt {
cmd: Command,

/// Repository to use if applicable
#[arg(long, default_value = "rust-lang/rust-project-goals")]
#[arg(long, default_value = "rust-lang/goals")]
repository: Repository,
}

Expand All @@ -51,7 +51,7 @@ enum Command {
dry_run: bool,
},

/// Use `gh` CLI tool to create issues on the rust-lang/rust-project-goals repository
/// Use `gh` CLI tool to create issues on the rust-lang/goals repository
Issues {
path: PathBuf,

Expand Down
2 changes: 1 addition & 1 deletion crates/rust-project-goals-cli/src/review.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use rust_project_goals::{
};
use walkdir::WalkDir;

const BASE_URL: &str = "https://rust-lang.github.io/rust-project-goals";
const BASE_URL: &str = "https://rust-lang.github.io/goals";

/// Generate a review summary for the given team.
pub fn review(team_name: &str, milestone: Option<&str>) -> Result<()> {
Expand Down
16 changes: 11 additions & 5 deletions crates/rust-project-goals-cli/src/rfc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,11 @@ fn rewrite_md_links(text: &str, timeframe: &str) -> String {

let clean_path = path_stem.trim_start_matches("../");
if clean_path.contains('/') || path_stem.starts_with("../") {
format!("](https://rust-lang.github.io/rust-project-goals/{clean_path}.html{fragment})")
format!("](https://rust-lang.github.io/goals/{clean_path}.html{fragment})")
} else {
format!("](https://rust-lang.github.io/rust-project-goals/{timeframe}/{clean_path}.html{fragment})")
format!(
"](https://rust-lang.github.io/goals/{timeframe}/{clean_path}.html{fragment})"
)
}
})
.to_string()
Expand All @@ -120,9 +122,11 @@ fn rewrite_ref_link_urls(ref_links: &mut BTreeMap<String, String>, timeframe: &s
let rest = caps.get(4).map_or("", |m| m.as_str());
let clean_path = path_stem.trim_start_matches("../");
if clean_path.contains('/') || path_stem.starts_with("../") {
*def = format!("{prefix}https://rust-lang.github.io/rust-project-goals/{clean_path}.html{rest}");
*def = format!("{prefix}https://rust-lang.github.io/goals/{clean_path}.html{rest}");
} else {
*def = format!("{prefix}https://rust-lang.github.io/rust-project-goals/{timeframe}/{clean_path}.html{rest}");
*def = format!(
"{prefix}https://rust-lang.github.io/goals/{timeframe}/{clean_path}.html{rest}"
);
}
}
}
Expand Down Expand Up @@ -683,7 +687,9 @@ fn issue<'doc>(timeframe: &str, document: &'doc GoalDocument) -> Result<GithubIs

fn goal_document_link(timeframe: &str, document: &GoalDocument) -> String {
let goal_file = document.link_path.file_stem().unwrap().to_str().unwrap();
format!("[{timeframe}/{goal_file}](https://rust-lang.github.io/rust-project-goals/{timeframe}/{goal_file}.html)")
format!(
"[{timeframe}/{goal_file}](https://rust-lang.github.io/goals/{timeframe}/{goal_file}.html)"
)
}

fn issue_text(timeframe: &str, document: &GoalDocument) -> Result<String> {
Expand Down
5 changes: 1 addition & 4 deletions crates/rust-project-goals-cli/src/team_repo.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,7 @@ fn ensure_person_file(owner: &str, team_repo_path: &std::path::PathBuf) -> Resul

fn team_file(owners: &BTreeSet<&str>) -> Result<String> {
let mut out = String::new();
writeln!(
out,
"# Auto-generated from the rust-project-goals repository"
)?;
writeln!(out, "# Auto-generated from the goals repository")?;
writeln!(out, "name = \"goal-owners\"")?;
writeln!(out, "kind = \"marker-team\"")?;
writeln!(out, "")?;
Expand Down
2 changes: 1 addition & 1 deletion crates/rust-project-goals-cli/src/updates.rs
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ fn prepare_goals(
issue_number: issue.number,
issue_assignees: comma(&issue.assignees),
issue_url: issue_id.url(),
issue_link_text: format!("rust-lang/rust-project-goals#{}", issue.number),
issue_link_text: format!("rust-lang/goals#{}", issue.number),
progress,
has_help_wanted,
help_wanted,
Expand Down
2 changes: 1 addition & 1 deletion crates/rust-project-goals-cli/src/updates/templates.rs
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ pub struct UpdatesGoal {
/// URL of the tracking issue
pub issue_url: String,

/// Link text for the issue (e.g., "rust-lang/rust-project-goals#123")
/// Link text for the issue (e.g., "rust-lang/goals#123")
pub issue_link_text: String,

/// True if the issue is closed.
Expand Down
2 changes: 1 addition & 1 deletion crates/rust-project-goals/src/gh/issue_id.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pub struct Repository {
/// Something like `rust-lang`
pub org: String,

/// Something like `rust-project-goals`
/// Something like `goals`
pub repo: String,
}

Expand Down
2 changes: 1 addition & 1 deletion crates/rust-project-goals/src/gh/issues.rs
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ pub fn create_issue(

// Output in stdout looks like
//
// https://github.com/rust-lang/rust-project-goals/issues/413}
// https://github.com/rust-lang/goals/issues/413}

for line in str::from_utf8(&output.stdout)?.lines() {
if let Some(issue_id) = IssueId::from_url(line.trim()) {
Expand Down
15 changes: 11 additions & 4 deletions crates/rust-project-goals/src/goal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,10 @@ impl FundingStatus {
FundingStatus::No
} else if s.eq_ignore_ascii_case("partial") {
FundingStatus::Partial(None)
} else if let Some(rest) = s.strip_prefix("Partial by ").or_else(|| s.strip_prefix("partial by ")) {
} else if let Some(rest) = s
.strip_prefix("Partial by ")
.or_else(|| s.strip_prefix("partial by "))
{
FundingStatus::Partial(Some(rest.trim().to_string()))
} else if s.eq_ignore_ascii_case("full") {
FundingStatus::Funded(None)
Expand Down Expand Up @@ -1599,10 +1602,10 @@ fn extract_metadata(sections: &[Section]) -> Result<Option<Metadata>> {
spanned::bail!(r[1], "accepted goals cannot have an empty tracking issue");
}

if has_tracking_issue && !r[1].contains("rust-project-goals#") {
if has_tracking_issue && !r[1].contains("goals#") {
spanned::bail!(
r[1],
"tracking issues are issues in the rust-project-goals repository. \
"tracking issues are issues in the rust-lang/goals repository. \
The `{}` issue can go in the `Other tracking issues` row.",
r[1].as_str(),
);
Expand Down Expand Up @@ -1759,7 +1762,11 @@ fn extract_funding(sections: &[Section]) -> Result<Vec<FundingItem>> {
let cost = FundingCost::parse(row[1].trim()).unwrap_or(FundingCost::Tbd);
let sponsors = {
let s = row[3].trim().to_string();
if s.is_empty() { None } else { Some(s) }
if s.is_empty() {
None
} else {
Some(s)
}
};
items.push(FundingItem {
purpose: row[0].to_string(),
Expand Down
3 changes: 1 addition & 2 deletions crates/rust-project-goals/src/re.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@ lazy_static! {

// Funding legend showing emoji meanings
lazy_static! {
pub static ref FUNDING_LEGEND: Regex =
Regex::new(r"\(\(\(FUNDING LEGEND\)\)\)").unwrap();
pub static ref FUNDING_LEGEND: Regex = Regex::new(r"\(\(\(FUNDING LEGEND\)\)\)").unwrap();
}

// Roadmap goal rows (no headers) filtered by roadmap name.
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/ATPIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|----------------|------------------------------------|
| Point of contact | @oli-obk |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#103] |
| Tracking issue | [rust-lang/goals#103] |
| Zulip channel | N/A |

## Summary
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/Patterns-of-empty-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @Nadrieril |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#115] |
| Tracking issue | [rust-lang/goals#115] |
| Zulip channel | N/A |
## Summary

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/Polonius.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @lqd |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#118] |
| Tracking issue | [rust-lang/goals#118] |
| Zulip channel | [#t-types/polonius][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/186049-t-types.2Fpolonius
Expand Down
6 changes: 3 additions & 3 deletions src/2024h2/Project-goal-slate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
| --- | --- |
| Point of contact | @nikomatsakis |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#102] |
| Zulip channel | [#project-goals][channel] |
| Tracking issue | [rust-lang/goals#102] |
| Zulip channel | [#goals][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/435869-project-goals
[channel]: https://rust-lang.zulipchat.com/#narrow/channel/435869-goals
*Extracted from [RFC 3614](https://github.com/rust-lang/rfcs/blob/master/text/3614-project-goals.md)*

## Summary
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/Rust-2024-Edition.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
| Point of contact | @traviscross |
| Status | Accepted |
| Flagship | Yes |
| Tracking issue | [rust-lang/rust-project-goals#117] |
| Tracking issue | [rust-lang/goals#117] |
| Zulip channel | [#edition][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/268952-edition
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/Rust-for-SciComp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @ZuseZ4 |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#109] |
| Tracking issue | [rust-lang/goals#109] |
| Other tracking issues | [rust-lang/rust#124509], [rust-lang/rust#124509] |
| Zulip channel | N/A |
## Summary
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/a-mir-formality.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @nikomatsakis |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#122] |
| Tracking issue | [rust-lang/goals#122] |
| Zulip channel | [#t-types/formality][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/402470-t-types.2Fformality
Expand Down
4 changes: 2 additions & 2 deletions src/2024h2/annotate-snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|------------------|------------------------------------|
| Point of contact | @Muscraft |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#123] |
| Tracking issue | [rust-lang/goals#123] |
| Zulip channel | N/A |
## Summary

Expand Down Expand Up @@ -34,7 +34,7 @@ The outputs of rustc and cargo are fully using annotate-snippets, with no regres
*This section is optional, but including [design axioms][da] can help you signal how you intend to balance constraints and tradeoffs (e.g., "prefer ease of use over performance" or vice versa). Teams should review the axioms and make sure they agree. [Read more about design axioms][da].*
- **Match rustc's output**: The output of annotate-snipepts should match rustc, modulo reasonable non-significant divergences
- **Works for Cargo (and other tools)**: annotate-snippets is meant to be used by any project that would like "Rust-style" output, so it should be designed to work with any project, not just rustc.
[da]: https://rust-lang.github.io/rust-project-goals/about/design_axioms.html
[da]: https://rust-lang.github.io/goals/about/design_axioms.html

## Ownership and team asks

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/async.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| Point of contact | @tmandry |
| Status | Accepted |
| Flagship | Yes |
| Tracking issue | [rust-lang/rust-project-goals#105] |
| Tracking issue | [rust-lang/goals#105] |
| Zulip channel | [#wg-async][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/187312-wg-async/
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/cargo-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @epage |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#119] |
| Tracking issue | [rust-lang/goals#119] |
| Zulip channel | N/A |

## Summary
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/cargo-semver-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @obi1kenobi |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#104] |
| Tracking issue | [rust-lang/goals#104] |
| Zulip channel | N/A |
## Summary

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/const-traits.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @fee1-dead |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#106] |
| Tracking issue | [rust-lang/goals#106] |
| Zulip channel | [#t-compiler/project-const-traits][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/419616-t-compiler.2Fproject-const-traits
Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/doc_cfg.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @GuillaumeGomez |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#120] |
| Tracking issue | [rust-lang/goals#120] |
| Zulip channel | N/A |
@GuillaumeGomez: https://github.com/GuillaumeGomez

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/ergonomic-rc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @jkelleyrtp |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#107] |
| Tracking issue | [rust-lang/goals#107] |
| Zulip channel | N/A |
## Summary

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/merged-doctests.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @GuillaumeGomez |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#111] |
| Tracking issue | [rust-lang/goals#111] |
| Zulip channel | N/A |
@GuillaumeGomez: https://github.com/GuillaumeGomez

Expand Down
2 changes: 1 addition & 1 deletion src/2024h2/min_generic_const_arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Point of contact | @BoxyUwU |
| Status | Accepted |
| Tracking issue | [rust-lang/rust-project-goals#100] |
| Tracking issue | [rust-lang/goals#100] |
| Zulip channel | [#project-const-generics][channel] |

[channel]: https://rust-lang.zulipchat.com/#narrow/channel/260443-project-const-generics/
Expand Down
Loading
Loading