Skip to main content

project-conventions

Core conventions and patterns for this codebase

Source facts

Repository
github/gh-aw
Last source activity
August 17, 2026 at 21:20
Detected SKILL.md language
English
Stars
5,404
Forks
588

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
project-conventions
description
Core conventions and patterns for this codebase
domain
project-conventions
confidence
medium
source
template
## 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.
View on GitHub