diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af03e1f..6a7c1b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ 首先,您需要复刻(Fork)这个仓库到您自己的 GitHub 账户。这样,您就可以在您自己的仓库中进行更改,而不会影响到原始项目。 -- 访问我们的GitHub页面。 +- 访问我们的 GitHub 页面。 - 点击页面右上角的“复刻(Fork)”按钮。 - 选择您想要复刻到的 GitHub 账户。 @@ -38,6 +38,7 @@ - 运行所有测试以确保没有引入新的错误。 - 使用有意义的提交信息来描述您所做的更改。 + ## 5. 创建拉取请求(Pull Request) 最后,当您准备好将更改合并回主项目时,您可以创建一个拉取请求。 @@ -47,4 +48,17 @@ - 填写拉取请求模板,详细说明您所做的更改以及它们为什么有用。 - 提交拉取请求。 -我们的维护团队将审查您的更改,并可能提出修改建议或批准合并。感谢您的贡献,让我们一起使这个项目变得更好! +### 关于分支 + +#### 常驻分支 + +- **main**: 此分支用于存放稳定的主代码,所有新功能或修复的 bug 都应**先提交到 dev 分支**,然后合并到 main 分支。 + +#### 其他临时分支 + +- **dev**: 此分支用于开发新的功能,在 dev 分支上进行开发,完成后合并到 main 分支。 +- **feat**: 此分支用于提交新的功能 +- **doc**: 此分支专门用于修复文档, 不涉及功能改动。 +- **fix**: 此分支专门用于修复 dev 分支中出现的错误。 + +我们的维护团队将审查您的更改,并可能提出修改建议或批准合并。感谢您的贡献,让我们一起使这个项目变得更好! \ No newline at end of file