Skip to content

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

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.

  • EXPLAINME.adoc: CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • SECURITY.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.

- `EXPLAINME.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `SECURITY.adoc`: CONTRIBUTING.md -> .github/CONTRIBUTING.md
@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown

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: f25bfa7e-84f7-481b-807b-4f16e20d4648

📥 Commits

Reviewing files that changed from the base of the PR and between 1b9bfcd and cd12eea.

📒 Files selected for processing (2)
  • EXPLAINME.adoc
  • SECURITY.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. (5)
  • GitHub Check: secret-scan / gitleaks
  • GitHub Check: secret-scan / shell-secrets
  • GitHub Check: secret-scan / rust-secrets
  • GitHub Check: check
  • GitHub Check: CodeQL Analysis (actions, none)
🔇 Additional comments (2)
EXPLAINME.adoc (1)

44-44: LGTM!

SECURITY.adoc (1)

413-413: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start documentation to link to the contributing guidelines in their current location.
    • Corrected the contributing guidelines link in the security documentation’s additional resources.

Walkthrough

The Quick Start and Additional Resources sections now link to .github/CONTRIBUTING.md instead of CONTRIBUTING.md.

Changes

Documentation links

Layer / File(s) Summary
Update contributing guide references
EXPLAINME.adoc, SECURITY.adoc
Both documentation links now point to .github/CONTRIBUTING.md.

Priority: ⬇️ Low

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

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation changes. It identifies that references were updated after the contributing guide moved.
Description check ✅ Passed The description accurately explains the relocated file and identifies both updated documentation references.
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.

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 reads each line,
The patch grows clear beneath the moon,
Small changes hop in place,
Tests guard the garden path,
Reviews bloom before the dawn.

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

@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 7286c82 into main Sep 19, 2026
6 of 8 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 13:17
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