Skip to content

fix(docs): list the contributing guide where it actually lives - #79

Merged
hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-structure-tree
Sep 19, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-structure-tree

Conversation

@hyperpolymath

@hyperpolymath hyperpolymath commented Sep 19, 2026

Copy link
Copy Markdown
Owner

The "Repository Structure" block still listed CONTRIBUTING.md at the repository root, but the guide lives at .github/CONTRIBUTING.md — the entry pointed at a location it had already moved away from.

This is the only change: the entry moves under the tree's existing .github/ branch, at the block's own comment column. The tree already rendered correctly and its layout is untouched.


The contributing guide was instantiated from the estate template and kept one of the template's tokens verbatim: {{MAIN_BRANCH}}, in

  1. Check if it's already fixed in {{MAIN_BRANCH}}

The token is correct in the template itself, but a reader of this repository sees it literally. It resolves to this repository's default branch. One token — nothing else in the guide changes.

@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 51 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 3ea2729e-8b7e-4677-80ea-62368b7320cd

📥 Commits

Reviewing files that changed from the base of the PR and between 327d8a8 and f259f28.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: f4ef0b42-a7be-4b9b-9054-a2da7fb79856

📥 Commits

Reviewing files that changed from the base of the PR and between a4a13b2 and 327d8a8.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md

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

📜 Recent review details
⏰ Context from checks skipped due to timeout. (26)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: ABI ↔ FFI structural conformance
  • GitHub Check: Groove manifest check
  • GitHub Check: Zig FFI builds + tests (Zig 0.14.0)
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: panic-attack assail
  • GitHub Check: Hypatia neurosymbolic scan
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

38-38: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation

    • Updated the repository structure shown in the contribution guidelines to accurately place the contribution guide within the .github directory.
    • Kept the existing file references and explanatory comment intact.
  • Style

    • Reformatted the repository structure listing for improved clarity and consistency.
    • No functional or behavioural changes were made.

Walkthrough

The repository tree in .github/CONTRIBUTING.md was updated. The CONTRIBUTING.md entry now appears inside the .github/ listing, before ISSUE_TEMPLATE/. No functional content changed.

Changes

Repository documentation

Layer / File(s) Summary
Reformat repository structure tree
.github/CONTRIBUTING.md
The CONTRIBUTING.md entry was moved from the top-level listing into the .github/ listing.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the repository-tree change, but it does not follow the required template. It omits the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also incl… Rewrite the description using the repository template. Include the required sections, list the single repository-tree change, record the testing status, and remove the unrelated {{MAIN_BRANCH}} claim unless that change is included in the …
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and concisely describes the documentation change. It matches the primary change in the pull request.
Full details: Description check

Explanation

The description explains the repository-tree change, but it does not follow the required template. It omits the Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also includes an unrelated claim about changing the {{MAIN_BRANCH}} token, which is not present in the stated changes.

Resolution

Rewrite the description using the repository template. Include the required sections, list the single repository-tree change, record the testing status, and remove the unrelated {{MAIN_BRANCH}} claim unless that change is included in the pull request.


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

A rabbit hops through the tree,
“CONTRIBUTING.md belongs here,” says she.
Beneath .github/, neat and bright,
The entries now stand in order right.
No code was changed in the night.

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

The repository-structure block listed `CONTRIBUTING.md` at the repository
root, but the guide lives at `.github/CONTRIBUTING.md` - the entry pointed
at a location it had already moved away from. The entry is moved under the
tree's existing `.github/` branch, at the block's own comment column; the
layout of the rest of the tree is untouched.
@hyperpolymath hyperpolymath changed the title fix(docs): rebuild the mangled repository-structure tree fix(docs): list the contributing guide where it actually lives Sep 19, 2026
@hyperpolymath
hyperpolymath force-pushed the fix/contributing-guide-structure-tree branch from a4a13b2 to 327d8a8 Compare September 19, 2026 14:57
coderabbitai[bot]
coderabbitai Bot previously approved these changes Sep 19, 2026
…ting guide

The guide is instantiated from the estate template, whose own copy legitimately holds
`{{MAIN_BRANCH}}`. Here it was never substituted, so the reader is told to check whether
a bug "is already fixed in `{{MAIN_BRANCH}}`". Resolved to this repository's default
branch. One token, no other change.
@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 1dde057 into main Sep 19, 2026
31 of 37 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant