project-conventions

Define and enforce project conventions for codebase practices.

49|6|Updated Aug 24, 2021

Search Tags:#documentation #patterns #coding-standards #code-style #starter-template #project-conventions

Ready to run

npx skills add https://github.com/webmaxru/bpm-counter --skill project-conventions-webmaxru

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/webmaxru/bpm-counter/tree/main/.copilot/skills/project-conventions
Command: npx skills add https://github.com/webmaxru/bpm-counter --skill project-conventions-webmaxru

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes and communicates consistent conventions and patterns for a codebase, helping teams align practices and accelerate AI-assisted development.

Core Features & Use Cases

Defines patterns for Context, Error Handling, Testing, Code Style, and File Structure to guide developers and AI agents.
Serves as a starter template for onboarding new projects, enforcing consistent practices across the codebase, and accelerating automated tooling development.

Quick Start

Replace the placeholder patterns below with your actual project conventions to tailor this skill to your codebase.

Frequently Asked Questions about project-conventions

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

FAQPage Schema

How do I establish coding standards and conventions for a new software project?▼

To establish coding standards, you define patterns for error handling, testing, code style, and file structure. This skill provides a starter template to standardize codebase practices and guide developers and AI agents during onboarding and code reviews.

What is the best way to enforce project conventions across my codebase?▼

The best way to enforce project conventions is by defining consistent patterns for context, error handling, testing, and code style. This skill serves as a starter template that standardizes practices and integrates into automation pipelines to ensure codebase alignment.

Can I use project conventions to accelerate AI-assisted development and onboarding?▼

Yes, you can use project conventions to accelerate AI-assisted development. By defining clear codebase patterns and documentation, this skill helps new developers onboard faster and ensures AI agents generate code that aligns with your existing project patterns.

Does this project conventions skill require any specific dependencies or components?▼

No, this project conventions skill requires no external dependencies or components. It uses a manifest with YAML frontmatter for name and description, and supports optional directories for scripts, references, and assets to tailor the conventions to your codebase.

How do I customize the starter template for my specific code style and documentation rules?▼

To customize the starter template for your code style and documentation rules, you replace the placeholder patterns with your actual project conventions. This tailors the skill to your codebase, specifying exact practices for error handling, testing, and file structure.