mirror of
https://github.com/vinta/awesome-python.git
synced 2026-11-20 06:40:51 +00:00
docs: name Second Tier demotions in audit commit bodies
Audit commit bodies named Second Tier demotions inconsistently, and README.md marks Second Tier nowhere, so finding the current entries from the git log needed a manual check of every hit. Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
234dee17f1
commit
cbe369335b
1 changed files with 1 additions and 1 deletions
|
|
@ -35,7 +35,7 @@ Run the `preview-verdicts` skill: it generates the interactive review page and d
|
|||
|
||||
## 5. Execute
|
||||
|
||||
When the run opens a branch, name it `audit/<section-slug>`, such as `audit/documentation`. One commit per section, with the subject `audit: sweep <Section>`, since the ranking script dates audits only from the step 1 prefixes: body lists each removal with its reason and downloads figure, naming the figure's source and fetch date so a later audit can tell whether a trend compares like with like (ClickPy counts mirror traffic, pypistats does not); restructures, tier moves, and reorders ride the same commit. A restructure that renames or dissolves a category or subcategory adds `"old path": "new path"` to `website/data/redirects.json` in that commit, so the old URL keeps its search ranking; the build fails when a redirect target no longer exists, so a later rename also updates the entries pointing at the renamed path. Format-only outcomes (no removals) are a single style commit whose subject starts `style: audit <Section>`. A section whose audit changes nothing gets a line under Last Audited in `docs/audit-logs.md` instead (`- <Section> -- <yyyy-mm-dd>, no changes.`, replacing its earlier line), committed, since the ranking script reads an audit only from a commit or that line. `make test` before every commit. After the last add or rename, re-run the ClickPy sweep, since new names have no cache row and the build would count them without downloads, then `make build`. Generic commit helpers tend to split a section audit into structural and per-subcategory commits — if that happens, squash back to one commit per section. Done when the tree is clean, tests passed before each commit, and the build count reconciles with the adjudicated changes.
|
||||
When the run opens a branch, name it `audit/<section-slug>`, such as `audit/documentation`. One commit per section, with the subject `audit: sweep <Section>`, since the ranking script dates audits only from the step 1 prefixes: body lists each removal with its reason and downloads figure, naming the figure's source and fetch date so a later audit can tell whether a trend compares like with like (ClickPy counts mirror traffic, pypistats does not); restructures, tier moves, and reorders ride the same commit. Name each demotion into the Second Tier in the body as `Second Tier: <entry>`, since nothing in README.md marks it and later work reads it from these bodies. A restructure that renames or dissolves a category or subcategory adds `"old path": "new path"` to `website/data/redirects.json` in that commit, so the old URL keeps its search ranking; the build fails when a redirect target no longer exists, so a later rename also updates the entries pointing at the renamed path. Format-only outcomes (no removals) are a single style commit whose subject starts `style: audit <Section>`. A section whose audit changes nothing gets a line under Last Audited in `docs/audit-logs.md` instead (`- <Section> -- <yyyy-mm-dd>, no changes.`, replacing its earlier line), committed, since the ranking script reads an audit only from a commit or that line. `make test` before every commit. After the last add or rename, re-run the ClickPy sweep, since new names have no cache row and the build would count them without downloads, then `make build`. Generic commit helpers tend to split a section audit into structural and per-subcategory commits — if that happens, squash back to one commit per section. Done when the tree is clean, tests passed before each commit, and the build count reconciles with the adjudicated changes.
|
||||
|
||||
## 6. Record
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue