You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Move the status badges to a Status section at the end of the README (issue btclib-org/.github#1856) - #492
The head of README.md carries only what the package is: section 2's software badges, then OpenSSF Best Practices and Baseline. The gates and the sentinels move to a closing ## Status section above the supported-by line, with the Scorecard badge as the last sentinel.
The comment above the badges becomes one line pointing to section 2 of btclib-org/.github's README.md, which holds the rules it restated.
This is one of the fifteen tree ports of section 2's ## Status rule, which PR btclib-org/.github#2105 set. It closes nothing. ISS btclib-org/.github#1856 is closed by hand once every tree has landed and .github's BACKLOG row for 1856 is gone.
Evidence
Check
Result
.github's test_a_readme_keeps_its_gates_and_sentinels_in_its_status_section, run from .github origin/main 3a774f4a
the tip passes; the base fails ("no ## Status section is the last ## section")
Badges kept
the sorted badge lines hash the same at the base and at the tip, with equal counts
Gates on 10c4501, under the gate lock (writer's log)
pre-commit run --all-files, the suite and the docs build with -W: exit 0
…issue btclib-org/.github#1856)
The head of README.md carries only what the package is: section 2's
software badges, then OpenSSF Best Practices and Baseline. The gates and
the sentinels move to a closing `## Status` section above the
supported-by line, with the Scorecard badge as the last sentinel.
The comment above the badges becomes one line pointing to section 2 of
btclib-org/.github's README.md, which holds the rules it restated.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Ferdinando Ametrano <ferdinando@ametrano.net>
No actionable comments were generated in the recent review.
Summary
Summary by CodeRabbit
Documentation
Added a “Status” section to the README with the workflow and OpenSSF Scorecard badges.
Updated badge guidance and clarified the Scorecard badge description.
The README now places workflow and OpenSSF Scorecard badges in a new Status section after Links. It replaces detailed badge-placement comments with a link to the organization’s README guidance. The Scorecard workflow comment now describes the badge’s Status section placement.
The README replaces detailed badge comments with a link to badge guidance and moves four badges to a Status section after Links. The Scorecard workflow comment describes the badge’s new location.
The badge reorganization presents no identified merge-blocking risk.
Architecture risk: Low · up to 10c45
The change affects 1 system.
Changed systems:README.md
Architecture concerns
No architecture-level concerns identified.
Review details
Systems and components
observed — README.md (service) was modified; 1 changed file maps to changed impact.
Before / after behavior
observed — Modified behavior in README.md: The detailed comments explaining badge categories, ordering, formatting, and where tooling choices are documented were replaced with a pointer to the organization’s README guidance.
observed — Modified behavior in README.md: The pre-commit, workflow, documentation-build, and OpenSSF Scorecard badges were removed from their former position after the package badges.
observed — Modified behavior in README.md: A “Status” section was added after “Links” containing the pre-commit, CI workflow, documentation-build, and OpenSSF Scorecard badges removed from the introductory badge area.
observed — Modified behavior in .github/workflows/scorecard.yml: The comment changes the badge description from one at the head of the README’s last line to the last badge in the README’s ## Status section; it also describes the Scorecard as published.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title "Move the status badges to a Status section at the end of the README (issue btclib-org/.github#1856)" matches the main change: the README's gates and sentinel badges move to a closing `## St…
Description check
The description states the purpose of the change: the README head keeps only the software badges plus OpenSSF Best Practices and Baseline, while the gates and the Scorecard sentinel move to a closing …
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "Move the status badges to a Status section at the end of the README (issue btclib-org/.github#1856)" matches the main change: the README's gates and sentinel badges move to a closing ## Status section, and the Scorecard workflow header comment is updated to match. The title names the issue reference, which helps traceability. The title cannot be checked against the organization's standard in full, because the referenced section 11 text was not retrieved. Under the criteria in this check, the title is related to the main change.
Full details: Description check
Explanation
The description states the purpose of the change: the README head keeps only the software badges plus OpenSSF Best Practices and Baseline, while the gates and the Scorecard sentinel move to a closing ## Status section. It also explains the one-line comment pointer, the related issue and PR, and the verification evidence. It is clearly related to the changeset.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
This review exceeded your plan’s limits and used usage-based reviews—free during trial, billed after paid activation unless disabled. Manage usage-based reviews.
non-blocking: .github/workflows/scorecard.yml:5-6: "the last badge of the README's ## Status section" says the order rule a second time. The badge is last only because scorecard holds the latest slot in section 10's calendar (Sunday 05), and section 2 of btclib-org/.github's README.md already sets that order. A later Sunday sentinel would make the comment wrong, and no test reads it. The standard's section 9, One fact in one place, is the rule. There is a suggestion inline. I leave it to the author.
Not checked: the PR body's .github test test_a_readme_keeps_its_gates_and_sentinels_in_its_status_section and its badge-hash comparison were not run. I have no interpreter.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
The head of README.md carries only what the package is: section 2's software badges, then OpenSSF Best Practices and Baseline. The gates and the sentinels move to a closing
## Statussection above the supported-by line, with the Scorecard badge as the last sentinel.The comment above the badges becomes one line pointing to section 2 of btclib-org/.github's README.md, which holds the rules it restated.
This is one of the fifteen tree ports of section 2's
## Statusrule, which PR btclib-org/.github#2105 set. It closes nothing. ISS btclib-org/.github#1856 is closed by hand once every tree has landed and.github's BACKLOG row for 1856 is gone.Evidence
.github'stest_a_readme_keeps_its_gates_and_sentinels_in_its_status_section, run from.githuborigin/main 3a774f4a## Statussection is the last##section")pre-commit run --all-files, the suite and the docs build with-W: exit 0origin/main980b2c6merge-treeexit 0, no conflictThe fresh review in the other client did not run. Codex answers: "ERROR: Your workspace is out of credits. Add credits to continue."
🤖 Generated with Claude Code