贡献指南

感谢您对 CarefreeCMS 的关注！我们欢迎任何形式的贡献。

如何贡献

报告问题

如果您发现 bug 或有功能建议，请：

  1. 在 Issues 中搜索是否已存在类似问题
  2. 如果没有，创建新 Issue
  3. 清晰描述问题或建议
  4. 如果是 bug，请提供复现步骤

提交代码

  1. Fork 项目到您的 GitHub 账号
  2. Clone 到本地：
    git clone https://github.com/YOUR-USERNAME/CarefreeCMS.git
  3. 创建新分支：
    git checkout -b feature/your-feature-name
  4. 进行开发并提交：
    git add .
git commit -m "feat: add some feature"
  5. Push 到您的仓库：
    git push origin feature/your-feature-name
  6. 创建 Pull Request

开发规范

代码风格

  • PHP 遵循 PSR-12 规范
  • JavaScript 使用 ES6+ 语法
  • 保持代码简洁易读
  • 添加必要的注释

提交消息规范

使用 约定式提交：

  • feat: 新功能
  • fix: 修复bug
  • docs: 文档更新
  • style: 代码格式调整
  • refactor: 重构
  • test: 测试相关
  • chore: 构建/工具相关

示例：

feat: 添加文章导出功能
fix: 修复分类删除bug
docs: 更新安装文档

测试

  • 确保所有测试通过
  • 为新功能添加测试
  • 运行测试：
    php think test

文档贡献

文档同样重要！您可以：

  • 修正文档错误
  • 补充说明
  • 翻译文档
  • 添加示例

文档位于 docs 目录，使用 VuePress 构建。

行为准则

  • 尊重他人
  • 保持友善
  • 接受建设性批评
  • 关注对项目最有利的事情

获取帮助

再次感谢您的贡献！