global-conventions
遵循项目范围内的开发约定,包括文件组织、版本控制、文档和依赖管理。在组织项目目录和文件、编写README文档、创建提交信息、使用git分支、管理拉取请求、配置环境变量、处理秘密和API密钥、管理项目依赖、设置功能标志、维护变更日志、定义测试要求、建立代码审查流程或构建整体项目架构时使用此技能。在设置新项目、重构项目结构、使用版本控制、管理配置文件或确保项目遵循一致的组织模式和最佳实践时应用此技能。
📖 中文导读:遵循项目范围内的开发约定,包括文件组织、版本控制、文档和依赖管理。在组织项目目录和文件、编写README文档、创建提交信息、使用git分支、管理拉取请求、配置环境变量、处理秘密和API密钥、管理项目依赖、设置功能标志、维护变更日志、定义测试要求、建立代码审查流程或构建整体项目架构时使用此技能。在设置新项目、重构项目结构、使用版本控制、管理配置文件或确保项目遵循一致的组织模式和最佳实践时应用此技能。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: Global Conventions description: Follow project-wide development conventions for file organization, version control, documentation, and dependency management. Use this skill when organizing project directories and files, writing README documentation, creating commit messages, working with git branches, managing pull requests, configuring environment variables, handling secrets and API keys, managing project dependencies, setting up feature flags, maintaining changelogs, defining testing requirements, establishing code review processes, or structuring the overall project architecture. Apply this skill when setting up new projects, refactoring project structure, working with version control, managing configuration files, or ensuring the project follows consistent organizational patterns and best practices.
Global Conventions
When to use this skill
- When organizing project directories and file structures
- When writing or updating README files and documentation
- When creating git commit messages
- When working with git branches (feature branches, main/master)
- When creating or reviewing pull requests and merge requests
- When configuring environment variables and .env files
- When handling secrets, API keys, and sensitive configuration
- When managing project dependencies (package.json, requirements.txt, Gemfile, etc.)
- When adding or updating dependencies
- When setting up or using feature flags
- When maintaining changelogs or release notes
- When defining testing requirements for merging code
- When establishing or following code review processes
- When structuring the overall project architecture
- When ensuring consistent patterns across the codebase
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