global-conventions
Follow established project structure, version control practices, documentation standards, and development workflows to maintain consistency across the team. Use this skill when organizing files and directories in a project. When writing README documentation or contributing guidelines. When creating git commits with clear messages or pull request descriptions. When managing environment configuration or dependencies. When setting up feature flags or maintaining changelogs. When establishing code review processes or testing requirements. This skill applies to all project management and development workflow tasks.
When & Why to Use This Skill
The Global Conventions skill ensures project-wide consistency by enforcing established coding standards, version control practices, and documentation workflows. It streamlines the development lifecycle by automating the organization of files, managing environment configurations, and maintaining clear communication through standardized git commits and pull requests, making it essential for team collaboration and long-term project maintainability.
Use Cases
- Project Structure Standardization: Automatically organizing files and directories according to team-specific or industry-standard architectural patterns.
- Automated Documentation Maintenance: Generating and updating README files, contribution guidelines, and changelogs to ensure project transparency and easy onboarding.
- Version Control Best Practices: Crafting clear, descriptive git commit messages and pull request descriptions that adhere to conventional commit standards.
- Dependency and Environment Management: Managing configuration files (like package.json or requirements.txt) and environment variables to prevent configuration drift across development environments.
- Workflow & Quality Assurance: Establishing and following rigorous code review processes and testing requirements to maintain high software quality before merging code.
| name | Global Conventions |
|---|---|
| description | Follow established project structure, version control practices, documentation standards, and development workflows to maintain consistency across the team. Use this skill when organizing files and directories in a project. When writing README documentation or contributing guidelines. When creating git commits with clear messages or pull request descriptions. When managing environment configuration or dependencies. When setting up feature flags or maintaining changelogs. When establishing code review processes or testing requirements. This skill applies to all project management and development workflow tasks. |
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 project files and directory structure
- When writing or updating README files with setup instructions or documentation
- When creating git commit messages or pull request descriptions
- When managing dependencies (package.json, requirements.txt, Cargo.toml, etc.)
- When configuring environment variables or secrets management
- When setting up feature flags for incomplete features
- When maintaining changelogs or release notes
- When establishing or following code review processes
- When defining testing requirements before merging code
- When documenting architecture decisions or contribution guidelines
Instructions
For details, refer to the information provided in this file: global conventions