Skip to content

DeepChat 贡献指南

Jump to bottom
zerob13 edited this page Feb 22, 2025 · 1 revision

贡献指南

欢迎大家参与DeepChat的开发！本指南旨在为所有开发者（无论是项目组内部成员还是外部贡献者）提供一份清晰的开发规范和 Issue/PR 处理流程，帮助大家更高效地协作并保证项目质量。

分支策略

项目组内部贡献者

  • Bug 修复 & 小型功能改进

    • 请直接在 dev 分支上进行开发。
    • 提交到 dev 分支的代码请保证功能基本正常、无编译错误（至少能够 npm run dev 正常启动）。

  • 大型功能新增或重构

    • 请创建新的分支，命名格式为 feature/featurename（其中 featurename 为具体功能名称）。
    • 完成开发后，再将 feature/featurename 分支合并到 dev 分支。

非项目组内部贡献者

  • 请先 Fork 本项目到您的个人仓库。
  • 在 Fork 后的仓库中进行开发，开发完成后提交 Pull Request（PR）。
  • PR 请以目标分支为 dev 分支，并在描述中说明您修复了哪些 Issue（如适用）。

Issue 处理流程

  • Issue 提交

    • 在提交 Issue 前，请先搜索是否已有类似的问题或讨论，避免重复提交。
    • 描述问题时请提供详细的复现步骤、预期行为与实际情况。

  • Issue 关联

    • 如果您的 PR 修复了某个 Issue，请在提交信息中关联对应 Issue。

  • 维护者跟进

    • 项目维护者会定期查看 Issue 并给予反馈，感谢您的贡献和耐心！

代码提交规范

  • 代码风格

    • 请遵循项目现有的代码风格，保持代码整洁、一致。(eslint)

  • 提交信息

    • 提交信息需要简明扼要，准确描述所做的改动，有Issue修复时关联相关 Issue。
    • 请确保每次提交都是功能完整且可运行的。

  • 本地测试

    • 在提交前，请确保本地所有功能均正常运行。

Pull Request 流程

  • 创建 PR 前

    • 请确保您的分支代码已经过充分自测，且没有编译错误。

  • PR 描述

    • 详细描述本次改动的内容、目的以及对现有功能的影响。
    • 如修复 Issue，请在描述中关联相应 Issue。

  • 代码评审

    • 维护者会对您的代码进行评审，并可能提出修改建议。
    • 经评审无误后，您的代码将会合并到 dev 分支中。

其他注意事项

  • 沟通协作

    • 如对开发流程或代码规范有疑问，请在 Issue 中提出或与项目维护者联系。

  • 文档更新

    • 如您在开发过程中发现文档不完善或有改进建议，也欢迎提交相关 PR。

  • 感谢参与

    • 每一位贡献者的付出都极大地推动了项目的发展，感谢您的热情与支持！
    • 期望在大家的共同努力下让本项目不断完善、稳定和高效。
    • 欢迎大家提出改进意见，让我们一起打造更好的项目！
Clone this wiki locally