From 7db072c202720fafe9ec2c96337078060bb1d50a Mon Sep 17 00:00:00 2001 From: trsdn Date: Wed, 16 Sep 2026 11:57:11 +0200 Subject: [PATCH] docs(standard): recommend release downloads badge Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 03507153-6639-4f22-a0ac-665d9b67ed44 --- .github/badges/conformance.svg | 6 +++--- .github/conformance.yml | 4 ++-- CHANGELOG.md | 9 +++++++++ docs/repository-quality-standard.md | 16 ++++++++++++++-- docs/self-assessment.md | 4 ++-- standard.yml | 4 ++-- templates/conformance.yml | 2 +- 7 files changed, 33 insertions(+), 12 deletions(-) diff --git a/.github/badges/conformance.svg b/.github/badges/conformance.svg index 272b93e..1509dc3 100644 --- a/.github/badges/conformance.svg +++ b/.github/badges/conformance.svg @@ -1,10 +1,10 @@ - - trsdn standard: v1.11.1 - Healthy + + trsdn standard: v1.11.2 - Healthy trsdn standard - v1.11.1 - Healthy + v1.11.2 - Healthy diff --git a/.github/conformance.yml b/.github/conformance.yml index 0f1c233..72cfe15 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.11.1" -assessed_on: "2026-09-02" +standard_version: "1.11.2" +assessed_on: "2026-09-16" state: "Healthy" evidence: "docs/self-assessment.md" diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e01c01..3e80650 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,15 @@ recorded here. Versions follow the compatibility policy in the [Repository Quality Standard](docs/repository-quality-standard.md). +## 1.11.2 - 2026-09-16 + +- Added a recommended dynamic total-download badge for repositories that publish + downloadable GitHub Release assets. +- Clarified that the badge reports asset downloads, not unique users or + installations, and includes checksum downloads. +- Patch release: this is optional guidance and does not change any `P08` + assessment result. + ## 1.11.1 - 2026-09-02 - Made diff --git a/docs/repository-quality-standard.md b/docs/repository-quality-standard.md index 71cc8f7..120f9d5 100644 --- a/docs/repository-quality-standard.md +++ b/docs/repository-quality-standard.md @@ -1,7 +1,7 @@ # Repository Quality Standard -- Version: 1.11.1 -- Last reviewed: 2026-09-02 +- Version: 1.11.2 +- Last reviewed: 2026-09-16 - Review cadence: every six months, even when nothing changes This document is the public source of truth for repository quality across @@ -836,6 +836,18 @@ Rules: A hardcoded `Swift 5.9` badge beside a manifest that has moved to 6.0 is the failure this section exists to prevent. +Where a repository publishes downloadable GitHub Release assets, a live total +download count is a useful optional signal. When maintainers choose to show it, +use the release assets as the authority and link the badge to the releases page: + +```md +[![Downloads](https://img.shields.io/github/downloads/OWNER/REPOSITORY/total?label=downloads)](https://github.com/OWNER/REPOSITORY/releases) +``` + +This badge is a recommendation, not part of the required badge block and not an +additional condition for `P08`. GitHub counts asset downloads rather than unique +users or installations, and checksum downloads are included in the total. + 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 diff --git a/docs/self-assessment.md b/docs/self-assessment.md index 7d99c03..8ef7c68 100644 --- a/docs/self-assessment.md +++ b/docs/self-assessment.md @@ -1,7 +1,7 @@ # Self-Assessment: trsdn/.github -- Standard version: 1.11.1 -- Assessed on: 2026-09-02 +- Standard version: 1.11.2 +- Assessed on: 2026-09-16 - State: **Healthy** - Record: [`.github/conformance.yml`](../.github/conformance.yml) diff --git a/standard.yml b/standard.yml index 7556249..34ec980 100644 --- a/standard.yml +++ b/standard.yml @@ -3,8 +3,8 @@ # Generated by scripts/standard.py from # docs/repository-quality-standard.md. Do not edit by hand. -version: "1.11.1" -last_reviewed: "2026-09-02" +version: "1.11.2" +last_reviewed: "2026-09-16" prefixes: A: "Archived" diff --git a/templates/conformance.yml b/templates/conformance.yml index 9fa1d55..97bb7a7 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.11.1" +standard_version: "1.11.2" assessed_on: "YYYY-MM-DD" state: "Needs work" evidence: "docs/self-assessment.md"