project-conventions

Define and enforce project-wide conventions for code quality and maintainability.

Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Izak90/Izak90.github.io --skill project-conventions-izak90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/Izak90/Izak90.github.io/tree/main/isaac_treinos_ar_livre/.copilot/skills/project-conventions
Command: npx skills add https://github.com/Izak90/Izak90.github.io --skill project-conventions-izak90

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes and communicates consistent conventions across the codebase to improve maintainability and onboarding.

Core Features & Use Cases

  • Documented patterns for code structure, error handling, testing, and formatting.
  • Guidance used during onboarding, code reviews, and automation checks.
  • Lightweight starter template to align this repository with its practices.

Quick Start

Apply these conventions to new and existing code in this repository to ensure consistency.

Frequently Asked Questions about project-conventions

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

FAQPage Schema
How do I standardize coding conventions across a repository?

To standardize coding conventions, document actionable guidelines for code structure, error handling, testing, and formatting in a Markdown file. This ensures consistent code quality and maintainability across the repository for developers, reviewers, and automation tooling.

What are code conventions and when do I need them for my project?

Code conventions are documented patterns for code structure, error handling, and formatting. You need them to improve maintainability and streamline onboarding, PR reviews, and CI checks across your repository.

How do I create a style guide for code reviews and onboarding?

Create a style guide by writing actionable guidelines in a Markdown body, optionally referencing scripts, references, and assets directories. This provides documented patterns for reviewers and new developers during onboarding and PR reviews.

Can I use project conventions to enforce formatting in CI checks?

Yes, project conventions target automation tooling during CI checks by defining project-wide guidelines. Documenting these patterns ensures automated systems can validate code quality and maintainability consistently across the repo.

Do I need any dependencies to set up code patterns for my repo?

No dependencies are required to set up code patterns. The conventions use a lightweight starter template with a SKILL.md frontmatter and Markdown body, optionally referencing scripts, references, and assets directories when provided.