Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

40 lines (22 loc) · 1.44 KB

为 magic-turn 做贡献

以下是为 MagiCode 做贡献的一组指南。在创建问题或拉取请求之前,请花几分钟时间阅读这些指南。

无论如何,这些只是指导方针,而不是规则,请使用您的最佳判断,并随时在拉取请求中提出对此文档的更改。

打开一个Issue

如果您认为您发现了一个错误,或者有一个新的功能想法,请首先确保它尚未被报告或修复。您可以搜索现有问题和 PR,看看是否有人报告过与您类似的问题。

接下来,创建一个新Issue,简要说明问题,并提供一些关于触发它的环境的背景,以及重现它的步骤。

提交拉取请求

欢迎拉取请求,并且有一些关于此的提示:

  • 在进行大的更改之前,最好先打开一个问题与维护人员讨论。

  • 如有疑问,请将您的拉取请求保持在较小的范围内。为了让 PR 获得被接受的最佳机会,不要在每个拉取请求中捆绑多个功能或错误修复。创建两个小 PR 总是比创建一个大 PR 更好。

  • 添加新功能或修改现有功能时,请尝试包含测试以确认新行为。

  • 在创建 PR 之前变基以保持提交历史清晰。

  • 为您的 PR 添加一些描述并参考相关问题。

入门

You will need Node.js >= 16

git clone [email protected]:chaorenluo/magic-turn.git

# Install dependencies
npm i

# Start development
npm dev