Global Conventions

Enforce consistent project conventions across files, documentation, and workflows.

6|1|Updated Nov 12, 2022

Search Tags:#git #workflow #project management #best practices #documentation #conventions #team collaboration

Ready to run

npx skills add https://github.com/coreyja/coreyja.com --skill global-conventions-coreyja

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Global Conventions
Source: https://github.com/coreyja/coreyja.com/tree/main/.claude/skills/global-conventions
Command: npx skills add https://github.com/coreyja/coreyja.com --skill global-conventions-coreyja

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill establishes and enforces consistent project structure, version control, and documentation standards, reducing onboarding time and improving team collaboration.

Core Features & Use Cases

Standardized Workflows: Guides file organization, git commit messages, and pull request descriptions for uniformity.
Documentation & Setup: Ensures READMEs, contributing guidelines, and environment configurations are clear and consistent.
Use Case: When setting up a new microservice, use this skill to ensure its directory structure, dependency management, and initial README documentation align with established project conventions.

Quick Start

Apply the Global Conventions skill to draft a new README.md file for the 'payment-gateway' service, ensuring it covers setup, environment variables, and contribution guidelines.

Frequently Asked Questions about Global Conventions

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

FAQPage Schema

How do I enforce consistent git commit messages across my team?▼

Consistent commit messaging standardizes your project's version control history. Global Conventions specifies functional and technical requirements for commit message formatting, enabling you to document changes uniformly and improve team collaboration across repository workflows.

What should a README and contribution guidelines include for new projects?▼

README files and contribution guidelines establish clear project expectations. Global Conventions ensures these documentation templates cover setup, environment variables, and contribution requirements consistently, reducing onboarding time and aligning new projects with established standards.

How do I organize directory structure and dependencies consistently across microservices?▼

Standardized file organization and dependency management reduce cognitive load across services. Global Conventions enforces consistent project structure, repository configuration, and environment setup across microservices, ensuring alignment with your team's established conventions.

Can I use conventions to govern code reviews and testing requirements?▼

Yes. Global Conventions specifies functional requirements for testing and review prerequisites, allowing you to codify testing standards and review gates uniformly across pull requests and development workflows.

What's the best way to maintain a changelog and manage feature flags across projects?▼

Consistent changelog generation and feature flag governance prevent scattered documentation. Global Conventions defines technical requirements for changelog maintenance and feature flag management, ensuring your deployment and release processes remain uniform across the codebase.