# 贡献指南 感谢你对 Claude Code SEO Assistant 的关注!我们欢迎各种形式的贡献。 --- ## 🤝 如何贡献 ### 贡献方式 1. **报告 Bug** - 发现问题请提交 Issue 2. **提出建议** - 有新功能想法请告诉我们 3. **提交代码** - 修复 Bug 或添加新功能 4. **完善文档** - 改进文档质量和准确性 5. **分享经验** - 分享你的使用经验和最佳实践 --- ## 🐛 报告 Bug ### 提交 Bug Issue 请包含以下信息: **标题格式:** `[Bug] 简短描述问题` **模板:** ```markdown ## Bug 描述 清晰地描述问题是什么 ## 复现步骤 1. 运行命令 '...' 2. 点击 '....' 3. 滚动到 '....' 4. 看到错误 ## 预期行为 描述应该发生什么 ## 实际行为 描述实际发生了什么 ## 环境信息 - OS: [例如 macOS 14.0] - Node.js 版本: [例如 18.0.0] - Next.js 版本: [例如 14.0.0] - 插件版本: [例如 1.0.0] ## 截图 如果适用,添加截图说明问题 ## 额外信息 其他相关信息 ``` --- ## 💡 功能建议 ### 提交 Feature Issue **标题格式:** `[Feature] 简短描述功能` **模板:** ```markdown ## 功能描述 清晰简洁地描述你想要的功能 ## 问题或需求 这个功能解决什么问题? 为什么需要这个功能? ## 解决方案 你希望这个功能如何实现? 是否有参考实现? ## 替代方案 是否考虑过其他解决方案? ## 优先级 - 高优先级 - 中优先级 - 低优先级 ``` --- ## 🔧 开发流程 ### 1. Fork 项目 点击 GitHub 页面右上角的 Fork 按钮 ### 2. 克隆仓库 ```bash # HTTPS 方式 git clone https://github.com/huifer/claude-code-seo.git # SSH 方式 git clone git@github.com:huifer/claude-code-seo.git # 进入项目目录 cd claude-code-seo ``` ### 3. 创建分支 ```bash # 更新主分支 git checkout main git pull origin main # 创建功能分支 git checkout -b feature/your-feature-name # 或修复分支 git checkout -b fix/your-bug-fix ``` ### 4. 进行修改 **项目结构:** ``` claude-code-seo/ ├── .claude-plugin/ # 插件配置 ├── skills/ # Skills 文件 ├── commands/ # 命令文件 ├── agents/ # Agent 文件 ├── templates/ # 模板文件 ├── resources/ # 资源文件 ├── docs/ # 文档 └── README.md # 主文档 ``` **开发规范:** 1. **代码风格** - 使用 Markdown 格式 - 遵循现有文件的结构 - 添加适当的注释 2. **文档编写** - 使用清晰的语言 - 提供示例 - 包含必要的上下文 3. **命名规范** - 文件名使用小写和连字符:`seo-check.md` - 目录名使用复数形式:`commands/`, `skills/` ### 5. 测试修改 ```bash # 在 Claude Code 中测试你的修改 # 确保所有功能正常工作 ``` ### 6. 提交更改 ```bash # 添加修改的文件 git add . # 提交更改 git commit -m "feat: add new SEO command" # 或使用更详细的提交信息 git commit -m "feat(commands): add keyword density checker - Calculate keyword density for content - Provide optimization suggestions - Support Chinese and English text Closes #123" ``` **提交信息格式:** 使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式: ``` ():