theupdateframework / theupdateframework/specification
Tracking changes between specification releases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 405
- Forks
- 59
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 1
Description
Clients should declare which version of the specification they implement and keep up-to-date with specification changes (see https://github.com/theupdateframework/python-tuf/issues/1598), but we as the specification do not make it easy to understand what has changed between specification versions.
We might solve this a number of ways:
- link to the diff between current (n) and previous (n-1) release
- manually curate a change list
- ???
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
Start by reviewing the linked python-tuf issue and the current and previous specification releases to determine how release changes are represented. Done means selecting and documenting a clear way for clients to understand changes between specification versions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100