Skip to content

fix(docs): repoint references to the relocated contributing guide - #50

Merged
hyperpolymath merged 1 commit into
mainfrom
refactor/contributing-guide-link-repair
Sep 19, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
refactor/contributing-guide-link-repair

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

fix(docs): repoint references to the relocated contributing guide

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

  • SECURITY.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • docs/QUICKSTART.adoc: ../CONTRIBUTING.md -> ../.github/CONTRIBUTING.md

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

- `SECURITY.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `docs/QUICKSTART.adoc`: ../CONTRIBUTING.md -> ../.github/CONTRIBUTING.md
@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: a4b0621a-81b3-491f-94c1-779d7e1921e2

📥 Commits

Reviewing files that changed from the base of the PR and between d0a3914 and 35ea1bc.

📒 Files selected for processing (2)
  • SECURITY.adoc
  • docs/QUICKSTART.adoc

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. (19)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Validate K9 contracts
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Groove manifest check
🧰 Additional context used
📓 Path-based instructions (1)
SPDX: `MPL-2.0` on all new files.

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Files:

  • SECURITY.adoc
  • docs/QUICKSTART.adoc
🔇 Additional comments (2)
SECURITY.adoc (1)

414-414: LGTM!

docs/QUICKSTART.adoc (1)

59-59: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated links in the security policy and Quickstart guide to point to the correct contributing guidelines resource.

Walkthrough

The security policy and Quickstart guide now link to .github/CONTRIBUTING.md instead of the repository-root path.

Changes

Documentation link updates

Layer / File(s) Summary
Update contribution guide links
SECURITY.adoc, docs/QUICKSTART.adoc
Both contribution guide links now point to .github/CONTRIBUTING.md.

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 documentation changes and the reason for them, but it does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and … Restructure the description using the repository template. Add the required sections, complete the RSR Quality Checklist, and state how the changes were tested. Add screenshots or terminal output if applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: updating documentation references to the relocated contributing guide.
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.
Full details: Description check

Explanation

The description explains the documentation changes and the reason for them, but it does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections.

  • ❌ 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 each guide with care
The links now hop to the right place
Security points the way
Quickstart follows today
.github/CONTRIBUTING.md is there

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

@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 56558d2 into main Sep 19, 2026
26 of 27 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 13:20
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