From b329c5bb6459ef8a5146e3e966d72f46d019040d Mon Sep 17 00:00:00 2001 From: trsdn Date: Fri, 25 Sep 2026 10:16:53 +0200 Subject: [PATCH] Add REC-02, the download badge, and close the PR that predated recommendations Pull request #61 proposed a download-count badge and said, in its own words, that it "is a recommendation, not part of the required badge block and not an additional condition for P08". It was written on 2026-09-16, a week before there was anywhere to put a recommendation, so it had to be optional prose inside the criterion it was careful not to change. There is somewhere now. The content is unchanged in substance; only its home is different, and being a recommendation is stated by where it sits rather than by a sentence asking the reader to treat it that way. The caveat from #61 is kept and sharpened: GitHub counts asset downloads rather than unique users or installations, and checksum downloads are in the total, so the number is a direction and not a figure. Patch, which is the first use of the rule the Recommendations section states: a recommendation produces no result, so no recorded result can change. The version in #61 was 1.11.2 and is now three versions stale, which is the other reason to land it fresh rather than rebase it. 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 | 4 ++-- CHANGELOG.md | 10 ++++++++++ docs/repository-quality-standard.md | 3 ++- docs/self-assessment.md | 4 ++-- standard.yml | 2 +- templates/conformance.yml | 2 +- 7 files changed, 21 insertions(+), 10 deletions(-) diff --git a/.github/badges/conformance.svg b/.github/badges/conformance.svg index 54e56e4..f515344 100644 --- a/.github/badges/conformance.svg +++ b/.github/badges/conformance.svg @@ -1,10 +1,10 @@ - - trsdn standard: v1.28.0 - Healthy + + trsdn standard: v1.28.1 - Healthy trsdn standard - v1.28.0 - Healthy + v1.28.1 - Healthy diff --git a/.github/conformance.yml b/.github/conformance.yml index b0265de..084cad2 100644 --- a/.github/conformance.yml +++ b/.github/conformance.yml @@ -6,8 +6,8 @@ # 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.0" -assessed_on: "2026-09-22" +standard_version: "1.28.1" +assessed_on: "2026-09-25" state: "Healthy" evidence: "docs/self-assessment.md" diff --git a/CHANGELOG.md b/CHANGELOG.md index 454fac5..f64850b 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.1 - 2026-09-25 + +- Added `REC-02`: a live total-download badge for repositories that publish + downloadable release assets, linked to the releases page. It is a + recommendation, so it is not part of the badge block `P08` requires and adds + no condition to it. +- Released as patch: a recommendation produces no result, so no recorded result + can change. This is the first change to use the rule + [Recommendations](docs/repository-quality-standard.md#recommendations) states. + ## 1.28.0 - 2026-09-22 - Added [Recommendations](docs/repository-quality-standard.md#recommendations): diff --git a/docs/repository-quality-standard.md b/docs/repository-quality-standard.md index c7da7d0..00d9d40 100644 --- a/docs/repository-quality-standard.md +++ b/docs/repository-quality-standard.md @@ -1,6 +1,6 @@ # Repository Quality Standard -- Version: 1.28.0 +- Version: 1.28.1 - Last reviewed: 2026-09-21 - Review cadence: every six months, even when nothing changes @@ -2075,6 +2075,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. | ## Changing This Standard diff --git a/docs/self-assessment.md b/docs/self-assessment.md index 2b28411..00144f7 100644 --- a/docs/self-assessment.md +++ b/docs/self-assessment.md @@ -1,7 +1,7 @@ # Self-Assessment: trsdn/.github -- Standard version: 1.28.0 -- Assessed on: 2026-09-22 +- Standard version: 1.28.1 +- Assessed on: 2026-09-25 - State: **Healthy** - Record: [`.github/conformance.yml`](../.github/conformance.yml) diff --git a/standard.yml b/standard.yml index 17f2405..71ce285 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.0" +version: "1.28.1" last_reviewed: "2026-09-21" prefixes: diff --git a/templates/conformance.yml b/templates/conformance.yml index bbe28f1..fb028e6 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.0" +standard_version: "1.28.1" assessed_on: "YYYY-MM-DD" state: "Needs work" evidence: "docs/self-assessment.md"