Skip to content

Commit 498ba4b

Browse files
authored
docs: add contributors markdown (#36)
1 parent bad5056 commit 498ba4b

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

CONTRIBUTORS.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# CONTRIBUTORS
22

3-
参考链接: [分支管理](https://www.ruanyifeng.com/blog/2012/07/git.html)
3+
If you would like to contribute to our project, please carefully read the following development conventions. Only when we have a consensus can our project get better and better.
4+
5+
## Contributing Code
6+
7+
### 1. Branch Management
8+
9+
Do not develop on the `master` branch. The `master` branch is only for merging pull requests and releasing versions. For daily development, please use the `dev` branch. For feature development, please create a feature branch named `feat-xxx`. Similarly, for bug fixes, please create a fix branch named `fix-xxx`.
10+
11+
### 2. Commit Process
12+
13+
After completing development and committing on the `dev` branch or a `feat-xxx` branch, please use `git rebase origin/master` for local merging. After resolving all code conflicts locally, submit a pull request to members with permission for timely merging.
14+
15+
## 3. About Feature and Dev Branches
16+
17+
By default, feature and fix branches will be deleted after being merged into `master` via pull request.
18+
19+
The `dev` branch will not be deleted.
20+
21+
## References
22+
23+
Reference Link: [Branch Management](https://www.ruanyifeng.com/blog/2012/07/git.html)

CONTRIBUTORS_CN.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# CONTRIBUTORS
2+
3+
如果你也想参与我们的项目共建,请详细阅读以下开发约定,只有大家拥有一个共识,我们的项目才会越来越好,
4+
5+
## 贡献代码
6+
7+
### 1. 分支管理
8+
9+
不要在`master`分支进行开发, `master`分支只进行`pr合并``发布版本`, 如果是日常开发, 请在`dev`分支进行开发, 如果是`新特性`开发,请创建特性分支`feat-xxx`,同理,`修复bug`, 请创建修复分支`fix-xxx`.
10+
11+
### 2. 提交流程
12+
13+
`dev`分支或者`feat-xxx`分支`开发完成``提交commit`之后, 请使用`git rebase origin/master`进行`本地合并`,在本地解决完成所有的代码冲突之后,再进行`pr请求`,`发送请求`到有权限的成员,会及时进行合并.
14+
15+
## 3. 关于特性分支和dev分支
16+
17+
默认`特性分支``修复分支`提交`pr`合并到`master`之后,会进行`删除`分支.
18+
19+
`dev`分支不会进行删除.
20+
21+
## 参考信息
22+
23+
参考链接: [分支管理](https://www.ruanyifeng.com/blog/2012/07/git.html)

0 commit comments

Comments
 (0)