Skip to content

Fix #279: add standard doc root pointers - #594

Merged
flyingrobots merged 2 commits into
mainfrom
fix-279-standard-doc-pointers
Jun 3, 2026
Merged

Fix #279: add standard doc root pointers#594
flyingrobots merged 2 commits into
mainfrom
fix-279-standard-doc-pointers

Conversation

@flyingrobots

Copy link
Copy Markdown
Member

Summary

  • add root-level pointers for the repository code of conduct, contributing guide, and security policy
  • keep the canonical full documents under .github/
  • add a repository docs guard that verifies each root pointer and canonical target exist

Closes #279

Validation

  • npm exec vitest run test/unit/scripts/repository-standard-docs.test.ts
  • npm exec markdownlint CODE_OF_CONDUCT.md CONTRIBUTING.md SECURITY.md
  • pre-push IRONCLAD gates 0-7 passed with WARP_QUICK_PUSH=1

@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@flyingrobots, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 22 minutes and 5 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 68727fbc-2699-4f9c-9601-8dce4b889503

📥 Commits

Reviewing files that changed from the base of the PR and between a21fb8b and 4f6312b.

📒 Files selected for processing (4)
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • SECURITY.md
  • test/unit/scripts/repository-standard-docs.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-279-standard-doc-pointers

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

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

@flyingrobots

Copy link
Copy Markdown
Member Author

Code Lawyer Findings

@codex please confirm this review posture.

Severity File Lines Type Issue Recommended mitigation prompt
P5 Nit CODE_OF_CONDUCT.md L1 Markdown style The root pointer heading uses Code Of Conduct; standard document title casing should keep the short preposition lowercase: Code of Conduct. Update the root pointer heading to # Code of Conduct and add a focused repository-standard-docs assertion so future pointer docs preserve expected root headings.

CI note: the only failing GitHub check is preflight, and its log failed in test/unit/domain/WarpGraph.subscribe.test.ts. That focused suite passes locally on this branch, so I am treating it as a transient CI failure and will rerun after the heading fix is pushed.

@flyingrobots

Copy link
Copy Markdown
Member Author

Code Lawyer Activity Summary

@codex please confirm this closure.

Source Severity File Lines Issue Commit Outcome
Self P5 Nit CODE_OF_CONDUCT.md L1 Root pointer heading used Code Of Conduct instead of standard Code of Conduct casing. 4f6312b0 Added a focused heading assertion in repository-standard-docs and fixed the heading.
CI P3 External/Transient test/unit/domain/WarpGraph.subscribe.test.ts hook setup Prior preflight failed in the subscribe suite, outside this branch diff. n/a Focused local rerun passed: 30/30 tests. New push should trigger fresh CI.

Validation:

  • RED: npm exec vitest run test/unit/scripts/repository-standard-docs.test.ts failed on # Code Of Conduct vs # Code of Conduct.
  • GREEN: npm exec vitest run test/unit/scripts/repository-standard-docs.test.ts
  • npm exec markdownlint CODE_OF_CONDUCT.md CONTRIBUTING.md SECURITY.md
  • npm run typecheck:test
  • git diff --check
  • WARP_QUICK_PUSH=1 git push static pre-push gates 0-7 passed; unit gate intentionally skipped by quick mode.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown

Release Preflight

  • package version: 18.0.0
  • prerelease: false
  • npm dist-tag on release: latest
  • npm pack dry-run: passed
  • jsr publish dry-run: passed

If you tag this commit as v18.0.0, release workflow will publish.

@flyingrobots
flyingrobots merged commit 01dbdc9 into main Jun 3, 2026
17 checks passed
@flyingrobots
flyingrobots deleted the fix-279-standard-doc-pointers branch June 3, 2026 22:10
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.

Standard repository docs exist only under .github/

1 participant