Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contributors markdown #36

Merged
merged 1 commit into from
Mar 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: add contributors markdown
wh131462 committed Mar 14, 2024
commit 235ad612bd6455545b1bd07e9cf103eb28b4d700
22 changes: 21 additions & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# CONTRIBUTORS

参考链接: [分支管理](https://www.ruanyifeng.com/blog/2012/07/git.html)
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.

## Contributing Code

### 1. Branch Management

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`.

### 2. Commit Process

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.

## 3. About Feature and Dev Branches

By default, feature and fix branches will be deleted after being merged into `master` via pull request.

The `dev` branch will not be deleted.

## References

Reference Link: [Branch Management](https://www.ruanyifeng.com/blog/2012/07/git.html)
23 changes: 23 additions & 0 deletions CONTRIBUTORS_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# CONTRIBUTORS

如果你也想参与我们的项目共建,请详细阅读以下开发约定,只有大家拥有一个共识,我们的项目才会越来越好,

## 贡献代码

### 1. 分支管理

不要在`master`分支进行开发, `master`分支只进行`pr合并``发布版本`, 如果是日常开发, 请在`dev`分支进行开发, 如果是`新特性`开发,请创建特性分支`feat-xxx`,同理,`修复bug`, 请创建修复分支`fix-xxx`.

### 2. 提交流程

`dev`分支或者`feat-xxx`分支`开发完成``提交commit`之后, 请使用`git rebase origin/master`进行`本地合并`,在本地解决完成所有的代码冲突之后,再进行`pr请求`,`发送请求`到有权限的成员,会及时进行合并.

## 3. 关于特性分支和dev分支

默认`特性分支``修复分支`提交`pr`合并到`master`之后,会进行`删除`分支.

`dev`分支不会进行删除.

## 参考信息

参考链接: [分支管理](https://www.ruanyifeng.com/blog/2012/07/git.html)