Skip to content

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

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

hyperpolymath merged 1 commit 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.

@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

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: ee2f8d52-0da0-45f1-bb8f-588c8a65ebde

📥 Commits

Reviewing files that changed from the base of the PR and between ff2a8b6 and 811a9f8.

📒 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. (27)
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: hypatia / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / gitleaks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / rust-secrets
  • GitHub Check: analyze (javascript-typescript, none)
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: panic-attack assail
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Groove manifest check
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: Patch Bridge CVE triage
  • GitHub Check: openssf-compliance

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to reflect that CONTRIBUTING.md is located in the .github/ directory.
    • Corrected the documented repository structure to match the current file layout.

Walkthrough

The repository structure tree now places CONTRIBUTING.md under .github/. The # This file annotation remains unchanged.

Changes

Repository documentation

Layer / File(s) Summary
Align repository structure tree
.github/CONTRIBUTING.md
The directory tree lists CONTRIBUTING.md under .github/. The existing # This file annotation remains in place.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 811a9

The documentation update does not break the repository validation check, so no actionable merge risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and its purpose, but it does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. Update the description to use the repository template. Add the required checklist entries, testing details, and applicable sections. Mark non-applicable items clearly.
✅ 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 describes the documentation change and identifies the incorrect repository location.
  • ❌ Autofix failed (check again to retry)

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 checks the tidy tree
CONTRIBUTING rests where it should be
The .github/ path is clear
Its file annotation stays near
One small move, and order grows
The repository neatly shows

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 ff2a8b6 to 811a9f8 Compare September 19, 2026 14:59
@sonarqubecloud

Copy link
Copy Markdown

@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

The agent ran but didn't make any changes. The issues may already be fixed or require manual intervention.

@hyperpolymath
hyperpolymath merged commit 5055318 into main Sep 19, 2026
33 of 36 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:19
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