Skip to content

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

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
Contributor

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: bf146826-c100-4466-8660-2fe2c761fc9b

📥 Commits

Reviewing files that changed from the base of the PR and between 0f3197d and d97b169.

📒 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: ffd0171c-d29e-4955-a410-46ef2ed050eb

📥 Commits

Reviewing files that changed from the base of the PR and between 81aa721 and 0f3197d.

📒 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. (24)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: analyze (actions, none)
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: panic-attack assail
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Groove manifest check
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: ABI ↔ FFI structural conformance
  • GitHub Check: Zig FFI builds + tests (Zig 0.14.0)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

38-38: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the documented repository structure in the contribution guidelines.
    • Corrected the placement of the contribution guidelines entry within the .github/ directory section.
    • Adjusted comment spacing for consistency with neighbouring entries.

Walkthrough

The contribution guide tree entry moved from the root-level listing into the .github/ section. Its comment spacing now matches the surrounding entries.

Changes

Contribution Guide

Layer / File(s) Summary
Directory tree layout
.github/CONTRIBUTING.md
The CONTRIBUTING.md entry moved into the .github/ section. Its comment spacing was aligned with sibling entries.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the main documentation change, but it omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also mentions a {{MAIN_BRANCH}} token… Rewrite the description using the repository template. Include the required sections, record the testing status, and either implement and document the {{MAIN_BRANCH}} change or remove that unrelated statement.
✅ 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 accurately describes the main change: it places the contributing guide at its actual .github/CONTRIBUTING.md location.
Full details: Description check

Explanation

The description explains the main documentation change, but it omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also mentions a {{MAIN_BRANCH}} token change that is not present in the supplied change summary or PR objective.


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 checked the tree
The guide hopped into place
Spacing lined up neatly
.github/ holds the trace
The directory smiles fin_ally

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 81aa721 to 0f3197d Compare September 19, 2026 14:59
…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 ebc2144 into main Sep 19, 2026
31 of 36 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:32
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