project-conventions

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

1|Updated Jul 7, 2026
One-click install
npx skills add https://github.com/seiggy/maf-copilot-studio-demo --skill project-conventions-seiggy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/seiggy/maf-copilot-studio-demo/tree/main/.squad/templates/skills/project-conventions
Command: npx skills add https://github.com/seiggy/maf-copilot-studio-demo --skill project-conventions-seiggy

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, and misplaced tests. ## Core Features & Use Cases - Convention Documentation: Captures error handling, testing, code style, and file structure patterns in one place. - Anti-Pattern Guidance: Lists practices to avoid so agents do not repeat known mistakes. - Use Case: A team onboarding an AI coding assistant fills in this template with their ESLint rules, Vitest setup, and folder layout so generated code matches existing project standards. ## Quick Start Fill in the placeholder sections of this template with your project's actual conventions for error handling, testing, code style, and file structure.

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?

Create a SKILL.md file with frontmatter containing name and description, then document error handling, testing, code style, and file structure patterns in the body. Agents load this context to match your codebase practices.

What should a project conventions skill include?

Include error handling approach, test framework and locations, linting and formatting rules, naming conventions, and directory structure. Add concrete code examples and a list of anti-patterns to avoid.

Why does AI-generated code not match my project style?

Agents default to generic patterns without project-specific context. Providing documented conventions for your linter, formatter, test framework, and folder layout aligns generated code with existing standards.

Can I use this template without modification?

No, this is a starter template with placeholder sections and HTML comments. You must replace the placeholders with your actual conventions, since inaccurate documentation degrades agent output quality.