You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Delegate Cargo.toml style guide to style team? #13313
@rust-lang/cargo previously discussed the possibility of formatting Cargo.toml. There are open questions around that, such as whether rustfmt or cargo fmt is responsible for doing the formatting.
This issue is to determine who has the responsibility for writing and maintaining the style guide for Cargo.toml. The old style team (years ago) did write a style guide for Cargo.toml manifests, but there was never any automated tooling to format manifests according to that style, so we don't want to presume that that style is well-established.
When this came up previously, cargo had at least one concern with the current style guidance, which I'm addressing with this PR: rust-lang/rust#120072 . Currently reviewing other potential concerns, and will post fixes for those as well, before the style guide gets used for any form of automatic formatting.
With my Cargo team hat on, I would propose that the Cargo team delegate responsibility for bikeshedding writing and maintaining the style guide for Cargo.toml manifest to the style team, with the understanding that:
The Cargo team can always raise objections if there's style guidance they have concerns with
The Cargo team can withdraw the delegation if they have unresolved concerns with how that work is being done
Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!
See this document for info about what commands tagged team members can give me.
This seems to almost complete delegate ownership. I think I would feel more comfortable delegating the task of definition, setting parameters and having a final T-cargo FCP, and as we get things settled, moving on to the more complete delegation mentioned here.
@epage So, the initial delegation would be "update the style guide to address all of T-cargo's concerns and we'll review it, FCP it, and consider delegating ongoing maintenance at that time"?
Thats roughly my thought. Not required we go that way but just a little concerned with the fact that the previous style guide had no teeth (no rustfmt) and had weird suggestions that ran counter to community norms so it seems like it'd be good to be more in the loop so we make sure we start in the right direction with a style guide that is getting teeth.
Activity
joshtriplett commentedon Jan 17, 2024
Starting an FCP for this, but also nominating it so that we can discuss it in our next meeting.
@rfcbot merge
rfcbot commentedon Jan 17, 2024
@joshtriplett has proposed to merge this. The next step is review by the rest of the tagged team members:
Concerns:
Cargo.tomlstyle guide to style team? #13313 (comment))Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!
See this document for info about what commands tagged team members can give me.
epage commentedon Jan 17, 2024
@rfcbot concern verify
This seems to almost complete delegate ownership. I think I would feel more comfortable delegating the task of definition, setting parameters and having a final T-cargo FCP, and as we get things settled, moving on to the more complete delegation mentioned here.
joshtriplett commentedon Jan 17, 2024
@epage So, the initial delegation would be "update the style guide to address all of T-cargo's concerns and we'll review it, FCP it, and consider delegating ongoing maintenance at that time"?
epage commentedon Jan 17, 2024
Thats roughly my thought. Not required we go that way but just a little concerned with the fact that the previous style guide had no teeth (no rustfmt) and had weird suggestions that ran counter to community norms so it seems like it'd be good to be more in the loop so we make sure we start in the right direction with a style guide that is getting teeth.