From 65109aa58f602df30356c2330815a004baba6c35 Mon Sep 17 00:00:00 2001 From: trsdn Date: Fri, 25 Sep 2026 10:24:14 +0200 Subject: [PATCH] Finish including #61: the authority for the count, and where it is findable MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moving #61 into REC-02 carried its substance and dropped two things worth keeping. The first is a phrase: the original said to use the release assets as the authority for the count. That matters, because a download figure can come from several places and they disagree — a package registry counts installs, a mirror counts its own traffic, and neither is what a release badge claims to show. The second is placement. #61 put this beside the badge rules, where somebody deciding what badges to show is already reading. REC-02 put it in the recommendations table, where somebody has to already know it exists. Status Badges now points at it and says plainly that it adds no condition to P08 and that its absence is not a gap, which is the question a reader of that section would otherwise have to go and answer elsewhere. Patch: a recommendation produces no result, and a cross-reference changes none either. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: f34e4f0b-ebd2-4432-9c55-9851a5e58c50 --- .github/badges/conformance.svg | 6 +++--- .github/conformance.yml | 2 +- CHANGELOG.md | 10 ++++++++++ docs/repository-quality-standard.md | 9 +++++++-- docs/self-assessment.md | 2 +- standard.yml | 2 +- templates/conformance.yml | 2 +- 7 files changed, 24 insertions(+), 9 deletions(-) diff --git a/.github/badges/conformance.svg b/.github/badges/conformance.svg index f515344..c69ff6a 100644 --- a/.github/badges/conformance.svg +++ b/.github/badges/conformance.svg @@ -1,10 +1,10 @@ - - trsdn standard: v1.28.1 - Healthy + + trsdn standard: v1.28.2 - Healthy trsdn standard - v1.28.1 - Healthy + v1.28.2 - Healthy diff --git a/.github/conformance.yml b/.github/conformance.yml index 084cad2..8901226 100644 --- a/.github/conformance.yml +++ b/.github/conformance.yml @@ -6,7 +6,7 @@ # The badge in .github/badges/ is generated from this file. Change the evidence # first, then this record, then regenerate. Never the other way round. -standard_version: "1.28.1" +standard_version: "1.28.2" assessed_on: "2026-09-25" state: "Healthy" evidence: "docs/self-assessment.md" diff --git a/CHANGELOG.md b/CHANGELOG.md index f64850b..9a39fcd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,16 @@ recorded here. Versions follow the compatibility policy in the [Repository Quality Standard](docs/repository-quality-standard.md). +## 1.28.2 - 2026-09-25 + +- `REC-02` now says to take the release assets as the authority for the count, + which was in the original proposal and was lost when it moved sections. +- [Status Badges](docs/repository-quality-standard.md#status-badges) points at + `REC-02`, so the badge is findable where a reader is already thinking about + badges rather than only in the recommendations table. +- Released as patch: a recommendation produces no result, and a cross-reference + changes none either. + ## 1.28.1 - 2026-09-25 - Added `REC-02`: a live total-download badge for repositories that publish diff --git a/docs/repository-quality-standard.md b/docs/repository-quality-standard.md index 00d9d40..3885f17 100644 --- a/docs/repository-quality-standard.md +++ b/docs/repository-quality-standard.md @@ -1,6 +1,6 @@ # Repository Quality Standard -- Version: 1.28.1 +- Version: 1.28.2 - Last reviewed: 2026-09-21 - Review cadence: every six months, even when nothing changes @@ -1762,6 +1762,11 @@ Rules: A hardcoded `Swift 5.9` badge beside a manifest that has moved to 6.0 is the failure this section exists to prevent. +A repository that publishes downloadable release assets may also show a live +total-download count. That badge is [`REC-02`](#recommendations) and not part of +the block this criterion requires, so it adds no condition to `P08` and its +absence is not a gap. + Badge hosting is not a privacy question on GitHub. Markdown rendered on `github.com` loads every external image through GitHub's proxy, so the image host observes the proxy and not the reader. The `Y02` argument applies where that @@ -2075,7 +2080,7 @@ which is how the same decision gets made differently in every repository. | | Recommendation | |---|---| | REC-01 | Name the performance-sensitive paths a change should be reviewed against, and how they are measured — a benchmark, a profiling routine, or a documented review pass. This was criterion `S14` until 1.28.0. It is worth doing and it is not worth assessing: whether a path is performance-sensitive is a judgement no fixed line decided consistently, so the criterion measured whether a sentence existed rather than whether the practice did. [A performance-review agent](../packages/performance-review/README.md) is one way to run such a review. | -| REC-02 | Where a repository publishes downloadable release assets, show a live total-download count and link it to the releases page: `[![Downloads](https://img.shields.io/github/downloads/OWNER/REPOSITORY/total?label=downloads)](https://github.com/OWNER/REPOSITORY/releases)`. It is not part of the badge block `P08` requires and adds no condition to it. GitHub counts asset downloads rather than unique users or installations, and checksum downloads are included in the total, so read it as a direction and not a figure. | +| REC-02 | Where a repository publishes downloadable release assets, show a live total-download count, taking the release assets as the authority and linking the badge to the releases page: `[![Downloads](https://img.shields.io/github/downloads/OWNER/REPOSITORY/total?label=downloads)](https://github.com/OWNER/REPOSITORY/releases)`. It is not part of the badge block `P08` requires and adds no condition to it. GitHub counts asset downloads rather than unique users or installations, and checksum downloads are included in the total, so read it as a direction and not a figure. | ## Changing This Standard diff --git a/docs/self-assessment.md b/docs/self-assessment.md index 00144f7..9b39ffe 100644 --- a/docs/self-assessment.md +++ b/docs/self-assessment.md @@ -1,6 +1,6 @@ # Self-Assessment: trsdn/.github -- Standard version: 1.28.1 +- Standard version: 1.28.2 - Assessed on: 2026-09-25 - State: **Healthy** - Record: [`.github/conformance.yml`](../.github/conformance.yml) diff --git a/standard.yml b/standard.yml index 71ce285..ce90e11 100644 --- a/standard.yml +++ b/standard.yml @@ -3,7 +3,7 @@ # Generated by scripts/standard.py from # docs/repository-quality-standard.md. Do not edit by hand. -version: "1.28.1" +version: "1.28.2" last_reviewed: "2026-09-21" prefixes: diff --git a/templates/conformance.yml b/templates/conformance.yml index fb028e6..a262bd3 100644 --- a/templates/conformance.yml +++ b/templates/conformance.yml @@ -20,7 +20,7 @@ # The badge is generated from this file. Change the evidence first, then this # record, then regenerate. Never the other way round. -standard_version: "1.28.1" +standard_version: "1.28.2" assessed_on: "YYYY-MM-DD" state: "Needs work" evidence: "docs/self-assessment.md"