Skip to content

docs: fix stale repo structure in copilot-instructions (follow-up to #17) #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmcky merged 2 commits into from
Jun 5, 2026
Merged

docs: fix stale repo structure in copilot-instructions (follow-up to #17) #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f89f697
docs: fix stale repo structure in copilot-instructions
mmcky Jun 5, 2026
c82ee14
docs: update Prompt Files section for consolidated prompt
mmcky Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,10 @@ action-style-guide/
│ ├── reviewer.py # LLM interaction with extended thinking (shared)
│ ├── github_handler.py # GitHub API interactions (action only)
│ ├── fix_applier.py # Apply fixes to markdown files (shared)
│ ├── prompt_loader.py # Load prompts and rules (shared)
│ ├── prompts/ # Minimal rule-agnostic prompt (identical for all categories)
│ │ ├── writing-prompt.md
│ │ ├── math-prompt.md
│ │ ├── ...
│ │ └── v0.6.1/ # Archived previous prompts
│ ├── categories.py # Single source of truth for category names (VALID_CATEGORIES)
│ ├── prompts/ # Single rule-agnostic prompt, shared across all categories
│ │ ├── prompt.md # The shared prompt
│ │ └── v0.6.1/ # Archived previous (per-category) prompts
│ └── rules/ # Category-specific rules
│ ├── writing-rules.md
│ ├── math-rules.md
Expand Down Expand Up @@ -81,9 +79,9 @@ action-style-guide/
- **Single source of truth**: Version in `__init__.py`

### Prompt Files
- **Location**: `style_checker/prompts/*.md`
- **Design**: All 8 prompt files are identical (rule-agnostic). Consolidation to single `prompt.md` planned (see PLAN.md 4.6).
- **Version tracking**: Each prompt has version comment at top: `<!-- Prompt Version: X.Y.Z | Last Updated: YYYY-MM-DD | Description -->`
- **Location**: `style_checker/prompts/prompt.md`
- **Design**: A single rule-agnostic prompt shared across all 8 categories (consolidated in #17; previously one identical file per category).
- **Version tracking**: The prompt has a version comment at top: `<!-- Prompt Version: X.Y.Z | Last Updated: YYYY-MM-DD | Description -->`
- **Archive**: Previous prompts archived in `style_checker/prompts/v0.6.1/`

### GitHub Integration
Expand Down
Loading