Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 1.36 KB

File metadata and controls

49 lines (41 loc) · 1.36 KB

贡献指南

欢迎参与 Claw Cooking 项目的贡献!无论是提交 Bug 报告、功能建议,还是直接贡献代码和文档,我们都非常欢迎。

贡献方式

1. 提交 Issue

  • 报告 Bug
  • 提出新功能建议
  • 讨论现有功能的改进
  • 提问和寻求帮助

2. 提交 Pull Request

  • 修复 Bug
  • 添加新功能
  • 完善文档
  • 优化配置和脚本

开发规范

文档规范

  • 使用 Markdown 格式
  • 语言简洁明了,通俗易懂
  • 中文和英文之间需要加空格
  • 代码块需要指定语言类型

脚本规范

  • Shell 脚本需要有注释说明
  • 要有错误处理和用户提示
  • 要兼容 macOS 和 Linux 系统
  • 要有执行权限:chmod +x script.sh

配置规范

  • YAML 格式要规范,缩进正确
  • 敏感信息要使用占位符
  • 要有注释说明每个配置项的含义

贡献流程

  1. Fork 本仓库
  2. 创建你的功能分支:git checkout -b feature/AmazingFeature
  3. 提交你的改动:git commit -m 'Add some AmazingFeature'
  4. 推送到分支:git push origin feature/AmazingFeature
  5. 提交 Pull Request

行为准则

我们希望所有贡献者都能遵守开源社区的基本行为准则:

  • 友好和尊重他人
  • 接受建设性的批评
  • 专注于对社区最有利的事情
  • 包容不同的观点和经验

如有任何问题,欢迎随时提交 Issue 讨论。