project-conventions

Document project conventions for consistent codebase patterns and onboarding.

Updated Jan 5, 2026
One-click install
npx skills add https://github.com/Golnaz89/golnaz89.github.io --skill project-conventions-golnaz89
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/Golnaz89/golnaz89.github.io/tree/main/.copilot/skills/project-conventions
Command: npx skills add https://github.com/Golnaz89/golnaz89.github.io --skill project-conventions-golnaz89

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document the core conventions and patterns used in this codebase to ensure consistent practices across teams and projects.

Core Features & Use Cases

  • Document standard patterns, naming conventions, folder structure, and review processes.
  • Serve as the single source of truth for onboarding and audits.

Quick Start

Document the team's actual project conventions by replacing the placeholder patterns.

Frequently Asked Questions about project-conventions

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

FAQPage Schema
How do I document coding standards and conventions for a new codebase?

To document coding standards for a codebase, you define standard patterns, naming conventions, folder structures, and review processes in a central reference, creating a single source of truth for consistent practices across teams.

What are project conventions and when do I need to document them?

Project conventions are documented patterns and standards for building and maintaining a codebase. You need them when onboarding new contributors, enforcing coding standards, or auditing architecture to ensure consistency across teams.

How do I standardize folder structure and naming conventions across multiple teams?

You standardize folder structure and naming conventions by documenting the team's actual patterns as a single source of truth, replacing placeholder patterns to enforce consistent codebase practices and architecture audits.

Can I use this to onboard new contributors to existing codebase patterns?

Yes, you can use this to onboard new contributors by providing a descriptive central reference of the project's actual conventions, serving as the authoritative source for standard codebase patterns and review processes.

What's the best way to enforce coding standards during architecture audits?

The best way to enforce coding standards during architecture audits is to maintain a documented set of project conventions, providing a single source of truth to verify consistent patterns and structural compliance across the codebase.

Does documenting project conventions require specific dependencies or formats?

Documenting project conventions requires no specific dependencies, but it satisfies requirements for YAML frontmatter with name and description, a descriptive Markdown body, and discovery-ready metadata to standardize the codebase.