CONTRIBUTING_CN.md

贡献指南

感谢您对参与 smart-doc 贡献的兴趣！详细的贡献指引请参考我们的官方 贡献指南文档。

核心要求

提交 Pull Request (PR) 前请确保：

• 📌 新功能需先讨论：通过 Issue 与社区对齐需求，避免重复劳动。
• 🧩 单焦点 PR：每次提交仅包含一个修复或功能，简化代码审查。
• 🌍 英文注释：代码注释使用英文，支持国际化协作。
• ✅ 代码质量：遵循 Spring Java Format 风格，添加单元测试。
• 📄 文档同步更新：若涉及功能变更，请同步更新 smart-doc-group.github.io 文档。
• 📝 提交信息规范：所有提交需严格遵循 Angular 提交规范。
  • 使用标准类型：feat（新功能）、fix（修复）、docs（文档）、style（格式调整）、refactor（重构）、test（测试）、chore（构建/依赖管理）等。
  • 主题与正文需简洁明确，避免“更新代码”等模糊描述。
  • 若关联 Issue，需在页脚注明（如 Closes #1234）。

文档与示例要求

若贡献包含以下内容：

• 🛠️ 配置项变更：
  • 检查 PR 是否新增/修改配置（如新增参数、修改默认值）。
  • 在 smart-doc-group.github.io 中补充或更新对应文档。
• 📚 新功能实现：
  • 在 smart-doc-example-cn 仓库提供使用示例，便于其他用户快速理解。

贡献步骤

1. Fork 仓库并本地克隆。
2. 创建新分支进行修改。
3. 使用 smart-doc 测试改动（参考 快速入门）。
4. 执行 mvn spring-javaformat:apply 格式化代码。
5. 向主仓库提交 PR。

社区互动

• 📰 在 Discussions 分享使用案例或技术文章。
• ❓ 在 Help 分类帮助解答用户疑问。
• 💡 在 Ideas 或 Show and tell 提出建议或展示相关工具。

您的贡献将帮助 smart-doc 更好地服务全球开发者！感谢支持！