skills.rest
codebytes
codebytesCOMMUNITY
Explore all skills by this author →
Website𝕏@chris_l_ayersGitHub

project-conventions

Documents codebase conventions, patterns, and anti-patterns for AI agent guidance.

Updated Jun 2, 2026
Search Tags:#template#testing#best practices#documentation#coding standards#code style#code conventions
One-click install
npx skills add https://github.com/codebytes/btt --skill project-conventions-codebytes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/codebytes/btt/tree/main/.squad/templates/skills/project-conventions
Command: npx skills add https://github.com/codebytes/btt --skill project-conventions-codebytes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? AI agents produce inconsistent code when they lack knowledge of a project's specific conventions, leading to style mismatches, wrong error handling patterns, and misplaced files. This Skill provides a structured template for capturing codebase-specific practices so agents follow your actual standards. ## Core Features & Use Cases - Convention Documentation: Records error handling, testing, code style, and file structure patterns in a standardized format. - Anti-Pattern Guardrails: Explicitly lists practices to avoid so agents do not repeat known mistakes. - Use Case: A team onboarding AI coding assistants fills in this template with their ESLint rules, Vitest setup, and folder layout so every agent session generates code that matches the existing codebase. ## Quick Start Replace the placeholder sections in this template with your project's actual error handling, testing, and code style conventions.

Frequently Asked Questions about project-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document project conventions for AI coding agents?▼

Fill in the template sections covering error handling, testing, code style, and file structure with your project's actual practices. Include concrete code examples and explicit anti-patterns so agents know both what to do and what to avoid.

What should a project conventions skill include?▼

Include your test framework and run commands, linter and formatter configuration, naming conventions, directory layout, and error handling approach. Add at least one code example demonstrating the conventions in practice.

Why do AI agents ignore my project's code style?▼

Agents default to generic patterns when no conventions are documented. Without explicit guidance on your ESLint config, test locations, and naming rules, generated code will not match your codebase standards.

When should I update the conventions documentation?▼

Update it whenever the project adopts a new framework, changes its folder structure, or switches tooling such as moving from Jest to Vitest. Stale conventions cause agents to generate outdated patterns.

Related Skills

Explore More Software Engineering Skills→
NoobyGainsNoobyGains
78

codebase-research

Search existing codebases for patterns, conventions, and similar implementations before writing new code.

Community
Intermediate
FacturaScriptsFacturaScripts
7

skill-pull-request

Standardize pull request creation with naming conventions and structured templates.

Official
Intermediate
arbazkhan971arbazkhan971
26

lint

Configure linters, formatters, pre-commit hooks, and CI enforcement across repositories.

Community
Advanced
lastcowlastcow

innozverse-repo-structure

Map the innozverse monorepo structure across apps, packages, and docs.

Community
Basic