📝 docs: write down the versioning rule, and restyle the footer - #14
Merged
Conversation
Without this written down, the next person to add a package to the trusted list ships it as a patch, because one line looks like a small change. It is not: it decides that something now merges without anyone looking. There is no API here to version, so the number tracks the only thing a consumer gets from this preset -- what merges unattended. Tightening is minor, loosening is major, even when the diff is the same size. A pin is a promise that the posture will not shift underneath someone. Also states that main is what an unpinned reference resolves to, so tags are for pinned consumers and merges do not each need one. Footer replaced with badges, monochrome. The supplied markup had a mangled href on the ownctrl badge -- a markdown link pasted inside an HTML attribute, leaving `[https://github.com/](...)ownctrl` -- pointed at github.com/ownctrl.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Versioning
Written into both READMEs. Without it, the next person to add a package to the trusted list ships it as a patch — one line looks small, but it decides that something now merges without anyone looking.
There is no API here to version, so the number tracks the only thing a consumer gets: what merges unattended.
Tightening is minor, loosening is major, even when the diff is the same size. If something stops automerging, the worst case is a few clicks. If something starts automerging, you have gone around the reason someone pinned.
Also states that
mainis what an unpinned reference resolves to — so tags are for pinned consumers, and not every merge needs one.Footer
Monochrome badges, both READMEs. One fix to the supplied markup: the ownctrl badge href was
[https://github.com/](https://github.com/enterprises/ownCTRL)ownctrl— a markdown link pasted inside an HTML attribute. Pointed atgithub.com/ownctrl.Header badges are still coloured. Say the word and they go monochrome too.
All three badge URLs verified rendering (
▲ Scroll: Top ▲,🩷 Maintained by: @miccy,©2026: ownCTRL™).