Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
125 lines (89 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

125 lines (89 loc) · 2.58 KB
Raw

贡献指南

感谢您对 CodingTool 项目感兴趣！我们欢迎任何形式的贡献，包括但不限于：功能改进、bug修复、文档完善等。

🌟 如何贡献

1. 提交 Issue

  • 在提交 Issue 之前，请先搜索是否已经存在相关的 Issue
  • 使用清晰的标题和详细的描述
  • 如果是 bug 报告，请提供：
    • 问题的详细描述
    • 复现步骤
    • 期望的行为
    • 实际的行为
    • 环境信息（操作系统、浏览器版本等）
    • 如可能，提供截图或录屏

2. Pull Request 流程

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的修改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建一个 Pull Request

3. 开发规范

代码风格

  • 使用 ESLint 进行代码检查
  • 遵循项目现有的代码风格
  • 保持代码简洁清晰
  • 添加必要的注释

Git 提交规范

提交信息格式：

<type>(<scope>): <subject>

<body>

<footer>

type 类型：

  • feat: 新功能
  • fix: 修复bug
  • docs: 文档更新
  • style: 代码格式（不影响代码运行的变动）
  • refactor: 重构（既不是新增功能，也不是修改bug的代码变动）
  • test: 增加测试
  • chore: 构建过程或辅助工具的变动

示例：

feat(encoder): 添加Base64文件编码功能

- 支持文件拖拽上传
- 添加文件大小限制
- 优化编码性能

Closes #123

4. 开发环境设置

  1. 安装依赖
npm install
  1. 运行开发服务器
npm run dev
  1. 运行测试
npm run test

5. 测试规范

  • 为新功能编写单元测试
  • 确保所有测试通过
  • 保持测试覆盖率
  • 编写有意义的测试用例

📝 文档贡献

  • 保持文档的准确性和时效性
  • 使用清晰简洁的语言
  • 添加必要的示例和说明
  • 更新文档时同步更新中英文版本

⭐ 行为准则

我们的承诺

为了营造一个开放和友好的环境，我们作为贡献者和维护者承诺：

  • 友善和包容
  • 尊重不同的观点和经验
  • 耐心接受建设性的批评
  • 关注最有利于社区的事情
  • 对其他社区成员表示同理心

不可接受的行为

不可接受的行为包括：

  • 使用性别、种族、宗教等方面的歧视性语言
  • 公开或私下的骚扰
  • 未经明确许可发布他人的私人信息
  • 其他不道德或不专业的行为

📞 联系方式

如果您有任何问题或建议，可以通过以下方式联系我们：

  • 提交 Issue

再次感谢您的贡献！