A changelogs directory is history too - #25
Merged
Conversation
`changelog` has been on `_HISTORICAL_NAMES` since the fastapi measurement, where one release-notes file produced 162 findings. It could not see the plural, so `cozystack/cozystack` was reported for `docs/changelogs/v1.3.4.md` naming a controller deleted five months after that release. A changelog being a changelog. Same class of miss as the version suffix taken this morning: the rule already knows the word and cannot see an ordinary spelling of it. Measured over every clone on disk rather than taken on the one finding, because one finding is not evidence and the convention is. FOUR repositories keep a `changelogs/` directory - coolify, cozystack, ruff, uv - and twelve keep one of `changelogs/`, `release-notes/`, `releasenotes/` or `.changeset/changelogs/`. The hyphenated and unseparated forms already matched; only the plural did not. cozystack goes from 3 findings to 2, and the two that remain are real. 201 tests.
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.
changeloghas been on_HISTORICAL_NAMESsince the fastapi measurement, where one release-notes file produced 162 findings. It cannot see the plural.cozystack/cozystack, sweep batch 11:The v1.3.4 notes are correct. That controller existed at v1.3.4 and was removed five months later.
Measured before taking it, because one finding is not evidence
The convention is. Counted across every clone on disk:
changelogs/release-notes/releasenotes/.changeset/changelogs/Twelve in total, and only the plural was missing.
release[-_ ]?notesalready covers the hyphenated and unseparated forms, which is why Pillow has been handled since the directory rule went in.Scope
changelogbecomeschangelogs?. Nothing else moves.docs/changelog-policy.md,docs/changelogging.mdanddocs/how-we-write-changelogs.mdstay judged, with assertions on each.src/changelogs.pydoes match and is left matching:find_docsyields.md,.rstand.txt, so a Python module never reaches this function, and the pre-existing singular had the same property.cozystack goes from 3 findings to 2, and both survivors are real.
201 tests.