global-conventions
遵循项目范围的开发约定,包括项目结构、文档标准、版本控制实践、环境配置和依赖管理。在组织文件和目录、编写文档、创建提交消息、管理环境变量、更新依赖或建立代码审查流程时使用此功能。确保一致的项目结构(src/、components/、utils/、tests/)、维护最新文档、使用清晰的提交消息和功能分支、正确配置环境变量而不提交秘密、保持依赖最小化并文档化,以及为未完成的工作实现功能标志时应用此功能。此功能确保整个团队遵循可预测的项目组织模式,为设置和架构维护全面文档,良好的版本控制卫生管理,安全地管理配置,并为测试和代码审查建立清晰的工作流程。
📖 中文导读:遵循项目范围的开发约定,包括项目结构、文档标准、版本控制实践、环境配置和依赖管理。在组织文件和目录、编写文档、创建提交消息、管理环境变量、更新依赖或建立代码审查流程时使用此功能。确保一致的项目结构(src/、components/、utils/、tests/)、维护最新文档、使用清晰的提交消息和功能分支、正确配置环境变量而不提交秘密、保持依赖最小化并文档化,以及为未完成的工作实现功能标志时应用此功能。此功能确保整个团队遵循可预测的项目组织模式,为设置和架构维护全面文档,良好的版本控制卫生管理,安全地管理配置,并为测试和代码审查建立清晰的工作流程。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: Global Conventions description: Follow project-wide development conventions including project structure, documentation standards, version control practices, environment configuration, and dependency management. Use this skill when organizing files and directories, writing README documentation, creating commit messages, managing environment variables, updating dependencies, or establishing code review processes. Apply this skill when ensuring consistent project structure (src/, components/, utils/, tests/), maintaining up-to-date documentation, using clear commit messages and feature branches, properly configuring environment variables without committing secrets, keeping dependencies minimal and documented, and implementing feature flags for incomplete work. This skill ensures the entire team follows predictable patterns for project organization, maintains comprehensive documentation for setup and architecture, practices good version control hygiene, manages configuration securely, and establishes clear workflows for testing and code review.
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 directories and file hierarchies
- When creating or updating README files, setup instructions, or architecture documentation
- When writing commit messages or creating feature branches
- When setting up environment configuration files (.env, config files)
- When managing secrets, API keys, or sensitive configuration (never commit to version control)
- When adding, removing, or updating project dependencies
- When documenting why major dependencies or architectural decisions were made
- When establishing or following code review processes and PR/MR conventions
- When implementing feature flags for incomplete features instead of long-lived branches
- When maintaining changelogs or release notes
- When ensuring project structure is logical and navigable (src/, tests/, docs/, config/)
- When defining testing requirements before merging (unit tests, integration tests, coverage)
- When setting up CI/CD pipelines or deployment workflows
- When onboarding new team members with clear contribution guidelines
Instructions
For details, refer to the information provided in this file: global conventions