CONTRIBUTING.md

贡献指南（CONTRIBUTING）

感谢你对 ethan-utils 的关注！为了保持项目的高质量和可维护性，请遵循以下贡献流程和规范：

1. 分支管理

• 所有功能开发、修复请从 main 分支拉取新分支，命名建议：feature/xxx、fix/xxx、chore/xxx。
• 不要直接在 main 分支提交代码。

2. 代码规范

• 遵循项目内的 ESLint、Prettier 规范，提交前请确保代码已通过 lint 检查。
• TypeScript 必须类型安全，避免使用 any，优先使用类型推断和类型声明。
• 目录结构、文件命名保持统一、简洁。

3. 提交规范

• 使用 Commitizen 工具，按照 Angular 规范提交（如：feat: 新增功能、fix: 修复 bug）。
• 提交信息需简明扼要，必要时补充详细描述。

4. Pull Request 流程

• 提交 PR 前请确保：
  • 代码已通过本地所有 lint、type check、测试（如有）
  • 合并目标为 main 分支
  • PR 描述清晰，说明变更内容和动机
• 每个 PR 建议只做一件事，避免大而杂的合并。

5. 代码审核与合并

• 所有 PR 需至少一位维护者审核通过后方可合并。
• 审核关注点包括：代码规范、功能实现、可读性、兼容性、文档完善等。

6. 自动化检查

• 项目集成了 lint、type check、格式化等自动化流程，CI 未通过的 PR 不予合并。

7. 文档与测试

• 新增/修改功能请同步完善相关文档（如 README、注释）。
• 建议为核心功能补充单元测试。

---

如有疑问或建议，欢迎在 issues 区讨论。感谢你的贡献！