Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

authors-file package field #14949

Closed
timmypidashev opened this issue Dec 17, 2024 · 2 comments
Closed

authors-file package field #14949

timmypidashev opened this issue Dec 17, 2024 · 2 comments
Labels
A-manifest Area: Cargo.toml issues C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` S-triage Status: This issue is waiting on initial triage.

Comments

@timmypidashev
Copy link

Problem

Hello 👋

I am building some rust software, and couldn't find a package field that allows for mentioning/referencing an AUTHORS file in the authors field. This is unfortunate, as I already make use of a non-standard license, and the license-file field came in very handy. I assumed something like authors-file should also exist, but alas.

When a project sees multiple contributions, It is not feasible to keep track of them all in a authors list, nor is it expandable. It would be nice to have a field where we can pass in a markdown or text file with a list of maintainers/contributors, and have cargo fetch that into its package metadata.

Proposed Solution

I propose adding an authors-file field to Cargo.toml that works similarly to the existing license-file field. Here's how it would work:

[package/workspace.package]
authors-file = "AUTHORS"

The AUTHORS file would support categorization through comments, with lines starting with # being used as category headers:

# Core Team
Your Name <[email protected]>

# Contributors
Another Author <[email protected]>

Additionally, we should provide support for GitHub's CONTRIBUTORS file format, allowing markdown formatting while extracting just the relevant contributor information.

Notes

This is my first potential contribution to the Rust ecosystem, and I'm really excited about it! It follows the precedent set by license-file and provides a more scalable alternative compared to listing authors directly in Cargo.toml.

I'd love to hear what others think and if its a good idea, I'd love to submit a pull request. Looking forward to getting involved with the Rust community through this feature! 😊

@timmypidashev timmypidashev added C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` S-triage Status: This issue is waiting on initial triage. labels Dec 17, 2024
@timmypidashev timmypidashev changed the title Feature request: authors-file package field authors-file` package field Dec 17, 2024
@timmypidashev timmypidashev changed the title authors-file` package field authors-file package field Dec 17, 2024
@epage epage added the A-manifest Area: Cargo.toml issues label Dec 17, 2024
@epage
Copy link
Contributor

epage commented Dec 17, 2024

package.authors used to be required and then it was made optional and de-emphasized / hidden in official tooling, see rust-lang/rfcs#3052

In that context, I'm not really seeing us making use of a package.authors-file in a meaningful way that having built-in support, especially designing out something semi-structured, would be worth it.

@timmypidashev
Copy link
Author

Thanks for the reply. That makes a lot more sense, and seeing as it's not even a requirement means anyone who is in need can simply default to using a CONTRIBUTORS file or the like. I will drop the issue 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-manifest Area: Cargo.toml issues C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` S-triage Status: This issue is waiting on initial triage.
Projects
None yet
Development

No branches or pull requests

2 participants