Skip to content

Delegate Cargo.toml style guide to style team? #13313

Open

Description

@joshtriplett

@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

Activity

  1. joshtriplett commented on Jan 17, 2024

    @joshtriplett
    MemberAuthor

    Starting an FCP for this, but also nominating it so that we can discuss it in our next meeting.

    @rfcbot merge

  2. rfcbot commented on Jan 17, 2024

    @rfcbot

    @joshtriplett has proposed to merge this. The next step is review by the rest of the tagged team members:

    Concerns:

    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.

  3. epage commented on Jan 17, 2024

    @epage
    Contributor

    @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.

  4. joshtriplett commented on Jan 17, 2024

    @joshtriplett
    MemberAuthor

    @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"?

  5. epage commented on Jan 17, 2024

    @epage
    Contributor

    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.

  6. moved this to FCP blocked in Cargo status trackeron Jan 23, 2024
  7. moved this from FCP blocked to Nominated in Cargo status trackeron Jan 23, 2024
  8. moved this from Nominated to FCP blocked in Cargo status trackeron Jan 30, 2024
  9. moved this from FCP blocked to Nominated in Cargo status trackeron Jan 30, 2024
  10. removed
    I-nominated-to-discussTo be discussed during issue triage on the next Cargo team meeting
    on Jan 30, 2024
  11. moved this from Nominated to FCP blocked in Cargo status trackeron Jan 30, 2024
  12. added
    S-triageStatus: This issue is waiting on initial triage.
    on Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    S-triageStatus: This issue is waiting on initial triage.T-cargoTeam: Cargodisposition-mergeFCP with intent to mergeproposed-final-comment-periodAn FCP proposal has started, but not yet signed off.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions