revisit revisions
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1.8k
- Forks
- 320
- Avg merge
- 11d 15h
- Merged PRs (30d)
- 1
Description
If I am not mistaken, a non-breaking change qualifies as a revision bump
Revision numbers start with lowercase r followed by an integer, which gets bumped whenever the spec is modified by merging a new PR.
https://github.com/libp2p/specs/blob/master/00-framework-02-document-header.md
Indeed, that's what the document says. We should change that. It doesn't make sense to bump the version for every change, e.g. in the extreme case fixing a typo.
Originally posted by @marten-seemann in https://github.com/libp2p/specs/issues/456#issuecomment-1252906980
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 reading 00-framework-02-document-header.md and the revision discussion linked from issue 456. Clarify which spec changes should trigger a revision bump, then update the document so its rule matches the agreed policy; done means the revision guidance no longer requires a bump for every change.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100