From 6e3e1a1cf16a351df12a68968cc3d1a473a0bb05 Mon Sep 17 00:00:00 2001 From: Timothy Liu Date: Sat, 16 Oct 2021 14:28:44 +0800 Subject: [PATCH] chore: Add contributing guide. --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cb21755d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# THUAI5 社区开发者贡献指南 + +## 分支管理 + ++ `master`: 主分支,用于记录阶段性成果,由管理员维护,需要 2 个 approving reviews ++ `dev`: 用于记录最新进展,由开发者进行维护,需要 1 个 approving review + +## 向 THUAI5 贡献代码 + ++ 将 `eesast/THUAI5` fork 到自己的仓库中 ++ 基于 `dev` 分支建立一个新的功能分支 ++ 在新的分支上进行修改与开发 ++ 向 `eesast/THUAI5` 的 `dev` 分支提出 pull request ++ 等待社区人员进行 review 与 merge + +## 向 THUAI5 贡献问题与思路 + +任何对 THUAI5 的建设有新思路的开发者、发现了 THUAI5 的 BUG 的人员,均可以在本仓库提出 issue。推荐使用本仓库设置的 issue 模板。 + +### 不要发布 “+1” 评论 + +类似于“+1”、“👍”、“\xxgg/”这类简短的无意义的评论不要出现在本仓库的评论中,推荐发表有意义的评论。 + +## 开发者交流 + +本仓库开启了“Discussion”,开发者可以在“Discussion”中进行沟通与交流。