TGMPA/TGM-Plugin-Activation 项目开发与贡献指南

TGMPA/TGM-Plugin-Activation 项目开发与贡献指南

项目概述

TGMPA/TGM-Plugin-Activation 是一个用于 WordPress 的插件管理工具，它帮助主题和插件开发者轻松管理其产品所需的依赖插件。该项目采用 git-flow 工作流进行开发管理，遵循 WordPress 编码标准，并有着严格的贡献规范。

开发环境准备

在开始为 TGMPA/TGM-Plugin-Activation 项目贡献代码前，需要做好以下准备工作：

1. 代码库克隆：获取项目最新代码，建议基于 develop 分支进行开发
2. 问题检查：在报告 bug 或提出改进前，应先检查 develop 分支是否已解决该问题
3. 问题跟踪：确保你的问题是新的，避免重复提交已被讨论过的问题

问题报告规范

当发现项目中的问题时，应按以下规范提交报告：

1. 问题描述：清晰说明问题现象及复现步骤
2. 错误信息：提供相关的 JavaScript 或 PHP 错误信息，对于 PHP 错误最好包含完整的调用栈
3. 版本信息：注明你使用的项目版本号
4. 辅助材料：可附加截图或视频帮助说明问题

代码修改流程

分支管理策略

项目采用 git-flow 分支模型，开发时应遵循以下规则：

1. 从 develop 分支创建特性分支
2. 分支命名规范：
   • 新功能：feature/功能名称，如 feature/auto-activate
   • 未报告的 bug 修复：feature/fix-问题描述，如 feature/fix-admin-notices
   • 已有问题的修复：feature/问题编号-描述，如 feature/123-auto-activate

编码规范

项目严格遵循 WordPress PHP 编码标准：

1. 使用 PHP_CodeSniffer 工具配合 WordPress 编码标准进行检查
2. 项目根目录已包含 phpcs.xml 配置文件，可直接运行 phpcs 命令进行检查
3. 提交前使用 git diff --check 检查不必要的空格

提交信息规范

提交代码时应遵循以下提交信息规范：

1. 主题行与正文间空一行
2. 主题行不超过50个字符
3. 主题行首字母大写，不以句号结尾
4. 使用祈使语气描述变更
5. 正文每行不超过72个字符
6. 正文应解释"做了什么"和"为什么做"，而非"如何做"
7. 关联已有问题编号

代码提交流程

1. 将修改推送到个人 fork 库的特性分支
2. 向原仓库的 develop 分支发起 Pull Request
3. 不要自行关闭关联的问题
4. 即使有写入权限，也应等待其他团队成员审核后再合并

安全与许可

1. 所有提交默认采用项目现有许可证
2. 无需对提交进行签名，项目从2.4.1版本开始会对标签进行GPG签名

开发建议

1. 原子提交：每个提交应是逻辑完整的变更单元
2. 清晰描述：提交信息应能准确反映变更内容
3. 代码审查：重视团队成员的代码审查意见
4. 持续集成：确保代码通过所有自动化测试

通过遵循这些规范，可以确保你的贡献能被高效地审核和合并，同时保持项目代码库的整洁和一致性。