Skip to content

docs: promote the licence footer into a License section - #67

Merged
WomB0ComB0 merged 2 commits into
mainfrom
docs/license-section
Sep 21, 2026
Merged

WomB0ComB0 merged 2 commits into
mainfrom
docs/license-section

Conversation

@WomB0ComB0

@WomB0ComB0 WomB0ComB0 commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

What

Promotes the licence footer at the bottom of README.md into a proper
## License section.

Why

The org repo-standards workflow added a README check that looks for a
## License (or ### Licence, or ## <emoji> License) heading. This repo
stated its licence, but only as a footer after a horizontal rule:

---
Apache-2.0 · © ResQ Systems, Inc.

Because it was not a heading, it did not appear in the document outline or in
GitHub's README sidebar navigation, so a reader scanning section headings for
licensing terms would not find it.

What changed

The horizontal rule becomes a ## License heading. The licence text and the
attribution line are byte-for-byte unchanged, and nothing else in the README
was touched — the diff is one line removed and two added.

Licence claim verified

The README's claim matches what the repo actually carries: there is an
Apache-2.0 LICENSE at the repo root, and GitHub's own licence detection
reports apache-2.0 for this repo. No relative link was added, so no new
link target needed creating.

Test plan

  • Extracted the README block from the merged repo-standards.yml checker
    and ran it against this clone: 1 violation before, 0 after.
  • Confirmed ## License introduces no duplicate H2 heading.
  • Confirmed the root LICENSE file is Apache-2.0.

Summary by CodeRabbit

  • Documentation
    • Clarified the README’s license section by adding a dedicated “License” heading and improving its separation from the publishing information.

The licence was already stated in a footer after a horizontal rule, so
it did not appear in the document outline or in GitHub's README sidebar
navigation. Promoting it to '## License' makes it findable without
changing the wording or the attribution.

The repo carries a genuine Apache-2.0 LICENSE at its root, which matches
the claim.
@github-actions github-actions Bot added size/XS C-Documentation Improvements or additions to documentation labels Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 269eb2ea-06b4-4888-93a1-dc4840237cdc

📥 Commits

Reviewing files that changed from the base of the PR and between 1024aca and a615068.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 59fea6c7-de50-48e0-9088-dfdc977c3e1d

📥 Commits

Reviewing files that changed from the base of the PR and between bca8002 and 1024aca.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README replaces the horizontal rule after the Publish section with a ## License heading. The existing license text remains unchanged.

Changes

README Documentation

Layer / File(s) Summary
Add license heading
README.md
The README introduces a ## License heading before the existing Apache-2.0 license line.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README change: promoting the licence footer into a dedicated License section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@WomB0ComB0
WomB0ComB0 merged commit 8faf219 into main Sep 21, 2026
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-Documentation Improvements or additions to documentation size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant