Issue #35: Add scope markers to all instruction files (Phase 2)#560
Merged
Conversation
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (36)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR standardises YAML frontmatter metadata across 35 instruction files in the ChangesInstruction File Standardisation & Enrichment
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
- Add 'scope: organization-wide' to 10 org-wide reusable files (a11y, coding-standards, community-standards, documentation-formats, issues, languages, linting, plugin-structure, pull-requests, quality-assurance) - Add 'scope: repo-local' to 26 repo-specific control-plane files - Add proper file_type and title fields to files missing them - All files pass frontmatter validation and markdown linting - Enables discoverability of org-wide files for reuse across LightSpeedWP repos Related to: Issue #35 (Instruction File Audit & Scope Clarification) https://claude.ai/code/session_016wfe4RRq6fm14DSZ6ZFGub
- Add 'Related Files' sections to 6 organization-wide instruction files - Link issues.instructions.md ↔ pull-requests.instructions.md (GitHub workflows) - Link coding-standards.instructions.md ↔ linting.instructions.md ↔ languages.instructions.md (Code quality) - Link documentation-formats.instructions.md to related documentation standards - All cross-links use relative paths for portability - Improves discoverability of related guidance - All files pass markdown linting (0 errors) Related to: Issue #35 (Instruction File Audit & Scope Clarification) https://claude.ai/code/session_016wfe4RRq6fm14DSZ6ZFGub
…se 4) Expanded 7 stub/minimal instruction files with comprehensive content: - prompt.instructions.md: Added 50+ lines on prompt file creation and frontmatter - hooks.instructions.md: Added 50+ lines on guardrail hooks and safety - labeling.instructions.md: Added 40+ lines on label categories and automation - tools.instructions.md: Added 35+ lines on tool documentation standards - template.instructions.md: Added 40+ lines on instruction file template and guidelines - readme.instructions.md: Added 45+ lines on README structure and accessibility - mermaid.instructions.md: Added 40+ lines on diagram types and guidelines All files now include: - Comprehensive frontmatter with metadata - Clear section structure with examples - Related file cross-references - Best practices and guidelines - All pass markdown linting (0 errors) Related to: Issue #35 (Instruction File Audit & Scope Clarification) https://claude.ai/code/session_016wfe4RRq6fm14DSZ6ZFGub
ashleyshaw
force-pushed
the
claude/hopeful-brahmagupta-9MeVh
branch
from
805f2dc to
d9f6ab2
Compare
14 tasks
github-actions
Bot
added
area:a11y
github-actions
Bot
added
type:documentation
Contributor
🔍 Reviewer Summary for PR #560CI Status: ✅ Recommendations
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completed Phases 2-4 of Issue #35: Added scope markers to all instruction files, cross-linked related files, and expanded stub files with comprehensive content.
Phase 2: Scope Markers ✅
scope: "organization-wide"to 10 org-wide reusable filesscope: "repo-local"to 26 repo-local control-plane filesfile_typeandtitlefields to files that lacked themPhase 3: Cross-Linking ✅
Added "Related Files" sections to facilitate navigation between related instruction files:
Phase 4: Expand Stub Files ✅
Expanded 7 stub/minimal instruction files with comprehensive content (40-50+ lines each):
Organization-Wide Files (10)
Files marked as reusable across all LightSpeedWP repositories:
Repo-Local Files (26)
Files specific to this
.githubcontrol plane remain marked as repo-local.Validation
✅ All 36 instruction files pass frontmatter validation
✅ Markdown linting: 0 errors (auto-fixed blank line issues)
✅ YAML structure preserved correctly
✅ All tests passing
✅ Cross-links use relative paths (portable)
Commits
1c4c915— Issue [AI Ops] Audit and patch instruction files for overlaps, scope, and cross-linking #35: Add scope markers to all 36 instruction files (Phase 2)6708e23— Issue [AI Ops] Audit and patch instruction files for overlaps, scope, and cross-linking #35: Add cross-linking between related instruction files (Phase 3)805f2dc— Issue [AI Ops] Audit and patch instruction files for overlaps, scope, and cross-linking #35: Expand stub instruction files with meaningful content (Phase 4)Next Steps
The audit is now complete with all 36 files:
Files are ready for:
/instructions/folder (Phase 5 - future work)Related Issues
Generated by Claude Code"