global-conventions

coreyja 的头像作者 coreyja

遵循既定的项目结构、版本控制实践、文档标准和开发工作流程,以保持团队一致性。在项目中组织文件和目录时使用此技能。编写README文档或贡献指南时。使用清晰的消息创建git提交或编写拉取请求描述时。管理环境配置或依赖项时。设置功能标志或维护变更日志时。建立代码审查流程或测试要求时。此技能适用于所有项目管理和开发工作流程任务。

📖 中文导读:遵循既定的项目结构、版本控制实践、文档标准和开发工作流程,以保持团队一致性。在项目中组织文件和目录时使用此技能。编写README文档或贡献指南时。使用清晰的消息创建git提交或编写拉取请求描述时。管理环境配置或依赖项时。设置功能标志或维护变更日志时。建立代码审查流程或测试要求时。此技能适用于所有项目管理和开发工作流程任务。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

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