global-conventions
Follow project-wide development conventions for file structure, documentation, version control, environment configuration, and code review processes. Use this skill when organizing project files and directories. When working with Git commits, branches, or pull requests. When managing environment variables or configuration files. When updating README or documentation files. When working with dependencies or package management. When considering feature flags or changelog entries.
When & Why to Use This Skill
This Claude skill ensures project-wide consistency by enforcing standardized development conventions for file organization, Git workflows, documentation, and environment configuration. It helps maintain high code quality and team alignment by automating adherence to project-specific rules, best practices, and architectural standards.
Use Cases
- Standardizing Git Workflows: Automatically generating commit messages, branch names, and pull request descriptions that follow the project's specific naming conventions.
- Project Structure Management: Organizing or restructuring directories and deciding the placement of new files based on established architectural patterns.
- Documentation Maintenance: Keeping README files, changelogs, and release notes up-to-date and formatted according to project style guides.
- Environment & Dependency Configuration: Managing .env files, environment variables, and package dependencies while ensuring secrets and API keys are never committed to version control.
- Code Review Preparation: Ensuring that all changes align with global project standards and feature flag policies before submitting for review.
| name | Global Conventions |
|---|---|
| description | Follow project-wide development conventions for file structure, documentation, version control, environment configuration, and code review processes. Use this skill when organizing project files and directories. When working with Git commits, branches, or pull requests. When managing environment variables or configuration files. When updating README or documentation files. When working with dependencies or package management. When considering feature flags or changelog entries. |
When to use this skill:
- When organizing or restructuring project files and directories
- When creating new files and deciding where they should go
- When writing Git commit messages
- When creating or naming Git branches
- When preparing pull/merge requests with descriptions
- When working with environment variables or .env files
- When managing project dependencies in package files
- When updating README or documentation files
- When setting up or reviewing code review processes
- When considering using feature flags for incomplete features
- When updating changelog or release notes
- When ensuring secrets and API keys are not committed
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.
Instructions
For details, refer to the information provided in this file: global conventions