|
| 1 | +# Copilot Instructions for basic-programming-skills Repository |
| 2 | + |
| 3 | +## Communication Style |
| 4 | + |
| 5 | +- **Minimal responses**: When a task is complete, respond with minimal confirmation like "done" or "done [brief description]" |
| 6 | +- **No summaries**: Don't generate summaries of changes unless explicitly requested |
| 7 | +- **No extra files**: Don't create planning files, notes, or tracking documents in the repository |
| 8 | +- **Action-focused**: Execute tasks directly without lengthy explanations unless asked |
| 9 | + |
| 10 | +## Repository Structure |
| 11 | + |
| 12 | +This is a **skills collection repository** with the following structure: |
| 13 | + |
| 14 | +``` |
| 15 | +basic-programming-skills/ |
| 16 | +├── skills/ # programming skills (SKILL.md files) |
| 17 | +├── ci/ # Release automation scripts |
| 18 | +├── .github/workflows/ # CI/CD pipelines |
| 19 | +└── docs/ # Documentation |
| 20 | +``` |
| 21 | + |
| 22 | +## Code Principles |
| 23 | + |
| 24 | +### Skills Format (v1.0.0) |
| 25 | + |
| 26 | +- Use **pseudocode only** - no language-specific code examples |
| 27 | +- Follow **AAA pattern** for all test examples (Arrange-Act-Assert) |
| 28 | +- Keep examples clear and language-agnostic |
| 29 | +- Structure: Principle → When to Use → Instructions → Examples → Testing |
| 30 | + |
| 31 | +### Documentation |
| 32 | + |
| 33 | +- README.md is a **reference index** - keep it short |
| 34 | +- Detailed content belongs in `docs/` folder |
| 35 | +- Don't duplicate documentation across files |
| 36 | +- Use tables and diagrams (mermaid) for clarity |
| 37 | + |
| 38 | +### Scripts |
| 39 | + |
| 40 | +- All shell commands in `ci/` folder - no inline scripts in workflows |
| 41 | +- Shell scripts must have LF line endings (enforced by .gitattributes) |
| 42 | +- Make scripts executable: `chmod +x` |
| 43 | + |
| 44 | +## Version Management |
| 45 | + |
| 46 | +- **v1.0.0** format: Simple pseudocode-based skills |
| 47 | +- Track changes in CHANGELOG.md |
| 48 | +- Only document skills changes, not infrastructure changes |
| 49 | +- Follow semantic versioning: Major.Minor.Patch |
| 50 | + |
| 51 | +## PR and Commit Format |
| 52 | + |
| 53 | +**PR Title Format:** |
| 54 | +``` |
| 55 | +<type>: <description> |
| 56 | +
|
| 57 | +Types: |
| 58 | +- feat: New skill added |
| 59 | +- improve: Existing skill improved |
| 60 | +- fix: Bug fix or correction |
| 61 | +- docs: Documentation only |
| 62 | +- chore: Build, CI/CD, tooling |
| 63 | +``` |
| 64 | + |
| 65 | +## File Handling |
| 66 | + |
| 67 | +- Don't create temporary/planning markdown files |
| 68 | +- Update CHANGELOG.md for skill changes only |
| 69 | +- Keep .gitignore minimal and relevant |
| 70 | +- Use .gitattributes for line ending consistency |
| 71 | + |
| 72 | +## When Working on Skills |
| 73 | + |
| 74 | +1. **Adding new skill**: Create `skills/skill-name/SKILL.md` |
| 75 | +2. **Update required**: README.md (table), CHANGELOG.md (if skill change) |
| 76 | +3. **Test format**: Always use AAA pattern with comments |
| 77 | +4. **Examples**: Good (✅) and Bad (❌) with explanations |
| 78 | + |
| 79 | +## CI/CD |
| 80 | + |
| 81 | +- Release on git tags: `v*` |
| 82 | +- Generate two artifacts: `cursor-antigravity.zip`, `copilot.zip` |
| 83 | +- Auto-generate release notes from merged PRs |
| 84 | +- Artifacts retention: 1 day (only needed during workflow) |
| 85 | + |
| 86 | +## Don't |
| 87 | + |
| 88 | +- ❌ Create `plan.md` or tracking files |
| 89 | +- ❌ Write lengthy summaries after completing tasks |
| 90 | +- ❌ Add language-specific code examples to skills |
| 91 | +- ❌ Duplicate content between README and docs/ |
| 92 | +- ❌ Inline shell commands in workflow YAML |
| 93 | +- ❌ Update CHANGELOG for non-skill changes |
| 94 | + |
| 95 | +## Do |
| 96 | + |
| 97 | +- ✅ Respond with "done [brief note]" when task complete |
| 98 | +- ✅ Use pseudocode for all examples |
| 99 | +- ✅ Follow AAA pattern for tests |
| 100 | +- ✅ Keep scripts in ci/ folder |
| 101 | +- ✅ Update CHANGELOG for skill additions/changes |
| 102 | +- ✅ Keep README as a reference index |
0 commit comments