cc-skill-project-guidelines-example

What it does

This skill provides structured project guidelines specifically designed for AI coding agents to ensure consistent output and adherence to architectural standards. It acts as a reference framework that directs the agent on how to approach, organize, and execute development tasks within a specific codebase context.

When to use it

• Onboarding new agents: Deploy when introducing an AI tool to a legacy codebase or a project with strict style guides to prevent drift.
• Enforcing architecture: Use during feature implementation to ensure the agent respects existing design patterns and folder structures.
• Standardizing documentation: Activate when generating commit messages, changelogs, or inline comments to maintain uniformity across the team.
• Refactoring safety: Apply before large-scale refactoring tasks to guarantee the agent understands constraints and dependencies.

Key capabilities

• Defines clear project structure and file organization rules.
• Specifies coding standards, naming conventions, and language-specific best practices.
• Outlines expected output formats for code generation and documentation.
• Sets boundaries for acceptable changes and integration protocols.

Example prompts

• "Review the attached project guidelines before generating code for the new authentication module."
• "Refactor this function according to the project guidelines regarding error handling and logging."
• "Generate a pull request description that aligns with the documentation standards defined in these guidelines."

Tips & gotchas

Ensure the project guidelines file is accessible within the agent's context window or knowledge base before initiating complex tasks. This skill relies on the accuracy of the provided guidelines; outdated rules may lead to incorrect code generation, so verify them against current team standards.