theupdateframework / theupdateframework/specification
Clarify backwards-incompatible changes sentence
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 405
- Forks
- 59
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 1
Description
In Document formats the spec states that
If a backwards incompatible format change is needed, a new filename can be used.
This looks like an artifact from before we adopted semantic versioning. We should remove or clarify this.
Contributor guide
No contributing guide indexed for this repository
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
Open tuf-spec.md at the Document formats section and review the sentence about backwards-incompatible format changes in the context of semantic versioning. Confirm whether the sentence should be removed or clarified, then update the specification so its guidance is no longer ambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100