Global Conventions

Enforce project-wide conventions for file organization, Git branches, and documentation.

Updated Aug 11, 2023
One-click install
npx skills add https://github.com/EIS-ITS/vss-cli --skill global-conventions-eis-its
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Global Conventions
Source: https://github.com/EIS-ITS/vss-cli/tree/main/.claude/skills/global-conventions
Command: npx skills add https://github.com/EIS-ITS/vss-cli --skill global-conventions-eis-its

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents collaboration issues and maintenance burdens caused by inconsistent project organization and development practices. It ensures adherence to project-wide conventions for structure, version control, and documentation, streamlining team workflows and improving code quality.

Core Features & Use Cases

  • Consistent Structure: Organize files and directories logically for easy navigation.
  • Version Control Best Practices: Guide on clear commit messages, branching strategies, and pull request workflows.
  • Environment Configuration: Standardize setup for development, testing, and production environments.
  • Use Case: When starting a new feature branch, use this skill to ensure your branch naming, commit messages, and file organization align with team standards, streamlining code reviews and accelerating integration.

Quick Start

Review the attached pull request for adherence to our project's global conventions, specifically checking commit message format and branch naming.

Frequently Asked Questions about Global Conventions

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

FAQPage Schema
How do I standardize project structure and file organization across my team?

Project structure standardization establishes consistent file organization, directory layouts, and naming conventions. Define a template for how codebases, documentation, and configuration are arranged, then enforce it across all team members' work. This reduces navigation friction and accelerates onboarding.

What are the best practices for Git commit messages and branch naming?

Version control best practices establish clear commit message formats and branch naming strategies that improve readability and traceability. Adopt conventions like descriptive commit subjects, consistent prefixes for branch types, and atomic commits. This streamlines code reviews and automates tooling.

How do I ensure consistent environment configuration across development, testing, and production?

Environment configuration standardization defines how development, testing, and production setups are configured, including secrets management and variable handling. Document environment requirements, version constraints, and setup steps once, then replicate them consistently. This prevents environment-specific bugs and deployment failures.

Why should I enforce consistent documentation across projects?

Consistent documentation conventions ensure all projects follow the same structure, format, and update process. This reduces cognitive load for developers switching between codebases and makes maintenance easier. Standards cover README structure, changelog formats, API documentation, and inline code comments.

What should a code review process include to maintain project conventions?

A standardized code review process checks adherence to conventions: commit message format, branch naming, file organization, documentation updates, and dependency tracking. Define review criteria explicitly so reviewers catch deviations early. This prevents inconsistencies from accumulating and keeps workflows efficient.