project-conventions
Core conventions and patterns for this codebase
Best use case
project-conventions is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Core conventions and patterns for this codebase
Teams using project-conventions should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/project-conventions/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How project-conventions Compares
| Feature / Agent | project-conventions | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Core conventions and patterns for this codebase
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
## Context > **This is a starter template.** Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality. ## Patterns ### [Pattern Name] Describe a key convention or practice used in this codebase. Be specific about what to do and why. ### Error Handling <!-- Example: How does your project handle errors? --> <!-- - Use try/catch with specific error types? --> <!-- - Log to a specific service? --> <!-- - Return error objects vs throwing? --> ### Testing <!-- Example: What test framework? Where do tests live? How to run them? --> <!-- - Test framework: Jest/Vitest/node:test/etc. --> <!-- - Test location: test/, __tests__/, *.test.ts, etc. --> <!-- - Run command: npm test, etc. --> ### Code Style <!-- Example: Linting, formatting, naming conventions --> <!-- - Linter: ESLint config? --> <!-- - Formatter: Prettier? --> <!-- - Naming: camelCase, snake_case, etc.? --> ### File Structure <!-- Example: How is the project organized? --> <!-- - src/ — Source code --> <!-- - test/ — Tests --> <!-- - docs/ — Documentation --> ## Examples ``` // Add code examples that demonstrate your conventions ``` ## Anti-Patterns <!-- List things to avoid in this codebase --> - **[Anti-pattern]** — Explanation of what not to do and why.
Related Skills
squad-conventions
Core conventions and patterns used in the Squad codebase
{skill-name}
{what this skill teaches agents}
xunit-v3-discovery
Fix xUnit v3 test projects that compile but show zero discovered tests under dotnet test.
result-web-feedback
Apply Result<T>-based feedback patterns in Razor Pages and HTMX flows.
result-foundation
Add or extend MoreSpeakers Domain Result types with explicit factory methods and structured errors.
reflection-contract-tests
Use reflection-based tests to lock an API contract before the implementation lands.
windows-compatibility
Cross-platform path handling and command patterns
test-discipline
Update tests when changing APIs — no exceptions
session-recovery
Find and resume interrupted Copilot CLI sessions using session_store queries
secret-handling
Never read .env files or write secrets to .squad/ committed files
release-process
Step-by-step release checklist for Squad — prevents v0.8.22-style disasters
Personal Squad — Skill Document
## What is a Personal Squad?