From 25f977680f60a49ec7c075927378d47368b53f7f Mon Sep 17 00:00:00 2001 From: luoye-cpu <3412829159@qq.com> Date: Wed, 11 Nov 2026 00:43:41 +0800 Subject: [PATCH] docs(readme-standard): keep the badge block one paragraph with trailing group comments Issue #3353: each badge group was introduced by an HTML comment on its own line, and a line that starts with an HTML comment opens a CommonMark HTML block that interrupts the badge paragraph, so every adopted README rendered the block as one centred row per group instead of one band. The group comments now trail the first badge line of their own group (the banner line for the first group) in the README exemplar, no line of the block starts with an HTML-comment opener, and docs/README-STANDARD.md prescribes that shape with the reason. The Praetor README-01 audit condition and the adopted-README sweep stay with their own repos per the issue's split. Signed-off-by: luoye-cpu <3412829159@qq.com> --- README.md | 19 ++++++------------- docs/README-STANDARD.md | 8 ++++++-- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 662bab473b..2a1afd965a 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,25 @@ wraps at 80. -->
- VMAFx — perceptual video quality assessment, GPU-accelerated and SIMD-tuned + VMAFx — perceptual video quality assessment, GPU-accelerated and SIMD-tuned - - - [![Release](https://img.shields.io/static/v1?label=release&message=v1.0.0-rc.3&style=for-the-badge&color=3b82f6&labelColor=111a35)](https://github.com/VMAFx/vmafx/releases) - + [![Release](https://img.shields.io/static/v1?label=release&message=v1.0.0-rc.3&style=for-the-badge&color=3b82f6&labelColor=111a35)](https://github.com/VMAFx/vmafx/releases) [![Tests](https://github.com/VMAFx/vmafx/actions/workflows/tests-and-quality-gates.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/tests-and-quality-gates.yml) [![Builds](https://github.com/VMAFx/vmafx/actions/workflows/libvmaf-build-matrix.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/libvmaf-build-matrix.yml) [![Lint](https://github.com/VMAFx/vmafx/actions/workflows/lint-and-format.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/lint-and-format.yml) [![FFmpeg](https://github.com/VMAFx/vmafx/actions/workflows/ffmpeg-integration.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/ffmpeg-integration.yml) [![Go](https://github.com/VMAFx/vmafx/actions/workflows/go-ci.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/go-ci.yml) [![Rust](https://github.com/VMAFx/vmafx/actions/workflows/rust-ci.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/rust-ci.yml) - - [![Security](https://github.com/VMAFx/vmafx/actions/workflows/security-scans.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/security-scans.yml) + [![Security](https://github.com/VMAFx/vmafx/actions/workflows/security-scans.yml/badge.svg?branch=master&event=push)](https://github.com/VMAFx/vmafx/actions/workflows/security-scans.yml) [![OpenSSF Scorecard](https://img.shields.io/badge/OpenSSF-Scorecard-06b6d4?style=for-the-badge&labelColor=111a35)](https://scorecard.dev/viewer/?uri=github.com/VMAFx/vmafx) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14549/badge)](https://www.bestpractices.dev/projects/14549) [![Codacy](https://app.codacy.com/project/badge/Grade/ca74eb98b9b94cfc8d60d965b836b55d)](https://app.codacy.com/gh/VMAFx/vmafx/dashboard) [![CodeRabbit](https://img.shields.io/badge/Reviews-CodeRabbit-8b5cf6?style=for-the-badge&logo=coderabbit&logoColor=white&labelColor=111a35)](https://coderabbit.ai) - - [![HISS-21](https://img.shields.io/badge/Standards-HISS--21-06b6d4?style=for-the-badge&logo=nasa&labelColor=111a35)](AGENTS.md) + [![HISS-21](https://img.shields.io/badge/Standards-HISS--21-06b6d4?style=for-the-badge&logo=nasa&labelColor=111a35)](AGENTS.md) [![Power of 10](https://img.shields.io/badge/NASA_JPL-Power_of_10-3b82f6?style=for-the-badge&logo=nasa&labelColor=111a35)](docs/principles.md) [![Conventional Commits](https://img.shields.io/badge/Commits-Conventional-8b5cf6?style=for-the-badge&logo=conventionalcommits&logoColor=white&labelColor=111a35)](CONTRIBUTING.md) - - [![License](https://img.shields.io/badge/License-EUPL--1.2_·_BSD--2--Clause--Patent-3b82f6?style=for-the-badge&labelColor=111a35)](docs/adr/1250-eupl-fork-relicense.md) - - [![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub-8b5cf6?style=for-the-badge&logo=githubsponsors&logoColor=white&labelColor=111a35)](https://github.com/sponsors/lusoris) + [![License](https://img.shields.io/badge/License-EUPL--1.2_·_BSD--2--Clause--Patent-3b82f6?style=for-the-badge&labelColor=111a35)](docs/adr/1250-eupl-fork-relicense.md) + [![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub-8b5cf6?style=for-the-badge&logo=githubsponsors&logoColor=white&labelColor=111a35)](https://github.com/sponsors/lusoris) [![Ko-fi](https://img.shields.io/badge/Support-Ko--fi-8b5cf6?style=for-the-badge&logo=kofi&logoColor=white&labelColor=111a35)](https://ko-fi.com/lusoris) **Perceptual video quality assessment — GPU-accelerated, SIMD-tuned, numerically exact** diff --git a/docs/README-STANDARD.md b/docs/README-STANDARD.md index 8e2cef2195..b6e3533e99 100644 --- a/docs/README-STANDARD.md +++ b/docs/README-STANDARD.md @@ -75,8 +75,12 @@ never reorders them: 5. **Licence**: one badge naming every licence that applies. 6. **Support**: sponsorship links (GitHub Sponsors, Ko-fi and the like). -Each group is introduced by an HTML comment (``) so a -reviewer can check the order without rendering the page. +Each group carries an HTML comment (``) so a reviewer can +check the order without rendering the page. The comment trails the first badge +line of its own group (the banner line for the first group) and never starts a +line of its own: a line that begins with `