Support multiple license files
Open
Nobody has claimed this yet.
A-license
A-manifest
C-feature-request
S-needs-design
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
Cargo's license-file manifest key allows a crate author to specify the path to a license file. However, some projects have different license files applying to different files. Cargo should add a new license-files (plural) key which takes an array of file paths, which would be mutually exclusive with the license-file key.
Discussion on internals here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing Cargo's existing license-file manifest handling and read the linked internals discussion. Determine how the array-valued license-files key should coexist with the singular key; the work is done when multiple license paths are accepted with the stated mutual exclusion behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100