global-conventions

Follow project-wide development conventions for project structure, documentation, version control, code review, environment configuration, dependency management, and security practices. Use this skill when setting up new projects, organizing file structures, writing project documentation, creating Git branches and commits, configuring environment variables, managing dependencies, setting up CI/CD pipelines, or implementing security practices. Apply when working on project setup tasks, creating documentation files (README.md, ARCHITECTURE.md, DATABASE_SCHEMA.md, API_REFERENCE.md, SETUP.md), Git workflow operations, .env files, package.json/bun.lockb, Docker configurations, or any cross-cutting project concerns. This skill ensures hybrid code organization (global shared code by type + feature-specific code with nested subdirectories), required documentation (README, ARCHITECTURE, DATABASE_SCHEMA, API_REFERENCE, SETUP - written before coding then updated), GitHub Flow workflow (main branch production-ready, feat

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️2downloads

When & Why to Use This Skill

This Claude skill provides a comprehensive framework for enforcing project-wide development conventions, ensuring consistency in project structure, documentation, and version control. It acts as a guardian for architectural integrity by organizing files into hybrid structures, managing environment configurations, and streamlining GitHub Flow workflows. By automating the creation and maintenance of essential technical documents like ARCHITECTURE.md and API_REFERENCE.md, it significantly improves codebase maintainability and team alignment.

Use Cases

  • Standardizing Project Structure: Organizing files using a hybrid approach that combines global shared code with nested, feature-specific subdirectories for better scalability.
  • Automated Technical Documentation: Generating and updating mandatory project files such as README.md, ARCHITECTURE.md, and DATABASE_SCHEMA.md to ensure the project remains well-documented throughout its lifecycle.
  • Workflow & Version Control: Managing Git branches and commits according to GitHub Flow standards to ensure the main branch remains production-ready and stable.
  • Environment & Dependency Management: Configuring .env files, Docker setups, and package dependencies (package.json/bun.lockb) while adhering to security best practices and team-wide conventions.
nameGlobal Conventions
descriptionFollow consistent project structure, version control practices, environment configuration, code review processes, and development conventions across the entire application. Use this skill when organizing project files and directories, when writing commit messages or creating pull requests, when managing environment variables and configuration, when participating in code reviews, when defining testing requirements, when using feature flags, when maintaining changelogs, when documenting setup instructions, or when establishing consistent development practices across the team.

Global Conventions

This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global conventions.

When to use this skill

  • When organizing or restructuring project files and directories
  • When writing commit messages, creating branches, or making pull requests
  • When managing environment variables and configuration files
  • When documenting features in README files or architecture documentation
  • When participating in code reviews as reviewer or author
  • When defining or following testing requirements before merging
  • When implementing feature flags for incomplete or experimental features
  • When maintaining changelog or release notes
  • When managing project dependencies and documenting why they're used
  • When setting up or updating contribution guidelines
  • When ensuring consistent practices across the development team
  • When making decisions about long-lived branches vs. feature flags

Instructions

For details, refer to the information provided in this file: global conventions