Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (81 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

117 lines (81 loc) · 3 KB
Raw

贡献指南

English | 简体中文

感谢你考虑为这个项目做出贡献！🎉

📋 目录

📜 行为准则

本项目及其所有参与者均受我们的行为准则约束。参与本项目即表示你同意遵守此准则。

🤝 如何贡献

报告 Bug

在创建 bug 报告之前，请先检查现有的 issue 以避免重复。创建 bug 报告时，请包含：

  • 清晰且描述性的标题
  • 重现问题的详细步骤
  • 预期行为与实际行为的对比
  • 如适用，请附上截图
  • 你的环境详情（操作系统、浏览器、版本等）

提出改进建议

改进建议通过 GitHub issues 进行跟踪。创建改进建议时，请包含：

  • 清晰且描述性的标题
  • 对提议功能的详细描述
  • 解释为什么这个改进会有用
  • 可能的实现方法

Pull Requests

  1. Fork 本仓库
  2. 创建新分支 (git checkout -b feature/amazing-feature)
  3. 进行你的修改
  4. 提交你的更改 (git commit -m '添加某个很棒的功能')
  5. 推送到分支 (git push origin feature/amazing-feature)
  6. 创建一个 Pull Request

🛠️ 开发环境设置

# 克隆仓库
git clone https://github.com/h1s97x/[repository-name].git

# 进入项目目录
cd [repository-name]

# 安装依赖
npm install  # 或 yarn install, pip install -r requirements.txt 等

# 运行测试
npm test

# 启动开发服务器
npm run dev

🔄 Pull Request 流程

  1. 确保你的代码遵循项目的代码风格指南
  2. 如有需要，更新文档
  3. 为新功能添加测试
  4. 确保所有测试通过
  5. 如适用，更新 README.md 中的变更详情
  6. PR 需要至少一位维护者的批准后才能合并

📝 代码风格指南

Git 提交信息

  • 使用现在时态（"添加功能" 而不是 "已添加功能"）
  • 使用祈使语气（"移动光标到..." 而不是 "移动光标到..."）
  • 第一行限制在 72 个字符以内
  • 在第一行之后可以自由引用 issues 和 pull requests

代码风格

  • 遵循项目中现有的代码风格
  • 使用有意义的变量名和函数名
  • 在必要的地方添加注释
  • 保持函数简短且专注
  • 编写自文档化的代码

文档

  • 使用清晰简洁的语言
  • 在适当的地方包含代码示例
  • 保持文档与代码变更同步
  • 使用正确的 markdown 格式

✅ 提交前检查清单

  • 代码遵循项目的代码风格指南
  • 已完成代码自审
  • 在难以理解的地方添加了注释
  • 已更新文档
  • 没有产生新的警告
  • 已添加测试且测试通过
  • 依赖的变更已合并并发布

🙏 感谢你

你的贡献让这个项目变得更好。我们感谢你的时间和努力！

如有疑问，欢迎通过创建 issue 或联系维护者来咨询。