Skip to content

Commit

Permalink
[docs]Guidelines: add commit message required
Browse files Browse the repository at this point in the history
Signed-off-by: Cyber-SiKu <[email protected]>
  • Loading branch information
Cyber-SiKu committed Nov 30, 2022
1 parent fc2c564 commit 134b1f3
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 0 deletions.
41 changes: 41 additions & 0 deletions Community_Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,47 @@ After you have a certain understanding of the Curve project, if you are interest
- In addition to the existing issues, you are also welcome to submit issues that you have discovered or new features you hope for and resolve them.
- You can pay attention to the *TODO* in the existing Curve code, most of which are code logic optimization and features to be supplemented, choose the ones you are interested in and raise relevant issues to follow up and try to solve.

For commit messages:

A good commit message needs to contain the following elements:

1. What is your change? (required)
2. Why this change was made? (required)
3. What effect does the commit have? (Optional)

The footer is optional and is used to record issues that can be closed due to these changes, such as `Close issue-12345`

Explain what changes have been made to the submitted PR: performance optimization? Fix bugs? add feature? and why. Finally, describe the impact of the following modifications, including performance and so on. Of course, for some simple modifications, the reasons and effects of the modifications can be ignored. Try to follow the following principles in the message:

- Summarize the function and role of PR
- Use short sentences and simple verbs
- Avoid long compound words and abbreviations

Please follow the following format as much as possible when submitting:

```
[type]<scope>:<description>
<BLANK LINE>
[body]
<BLANK LINE>
[footer]
```

type can be one of the following types:

- build: Affects system builds and external dependencies
- ci: Affects continuous inheritance related functions
- docs: Documentation related changes
- feat: Add new features
- fix: A bug fix
- perf: Performance improvement
- refactor: Refactor related code without adding functionality or fixing bugs
- style: Modifications that do not affect the meaning of the code, only modify the code style
- test: Modifications related to unit testing

The first line indicates that the title should be kept within 70 characters as much as possible, explaining the modified module and content, multiple modules can be represented by `*`, and the modified module is explained in the text stage.

The footer is optional and is used to record issues that can be closed due to these changes, such as `Close #12345`

## How to submit a proposal

Expand Down
40 changes: 40 additions & 0 deletions Community_Guidelines_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,46 @@ Curve 社区有多个[沟通渠道](#社区交流),每两周还会有线上的
- CI 通过之后可开始进行 review,每个 PR 在合并之前都需要至少得到两个 Committer/Maintainer 的 LGTM。
- PR 代码需要一定量的注释来使代码容易理解,且所有注释和 review 意见和回复均要求使用英语。

对于 commit message:

一条好的 commit message 需要包含以下要素:

1. What is your change?(必须)
2. Why this change was made?(必须)
3. What effect does the commit have? (可选)

说明提交的 PR 做了那些修改:性能优化?修复bug?增加功能?以及这么做的原因。最后描述以下这样修改带来的影响,包括性能等等。当然对一些简单的修改,修改的原因和影响可以忽略。在 message中尽量遵循以下原则:

- 总结说明 PR 的功能和作用
- 使用短句和简单的动词
- 避免长的复合词和缩写

在提交时请尽可能的遵循以下格式:

```
[type]<scope>: <description>
<BLANK LINE>
[body]
<BLANK LINE>
[footer]
```

type 可以是以下类型之一:

- build: 影响系统构建以及外部依赖
- ci: 影响持续继承相关的功能
- docs: 文档相关的修改
- feat: 增加新的特性
- fix: bug 修复
- perf: 性能提升
- refactor: 重构相关的代码,不增加功能也不修复错误
- style: 不影响代码的的含义的修改,仅仅是修改代码风格
- test: 单元测试相关的修改

第一行表示标题应尽可能保持 70 个字符以内,阐述修改的模块以及内容,多模块可以使用 `*` 来表示,并在正文阶段说明修改的模块。

footer 是可选的,用来记录对应因为这些更改而可以关闭的 issue,如 `Close #12345`

## 社区交流

目前 Curve 社区有多个沟通交流的渠道,请根据自己的需求选择合适高效的沟通方式:
Expand Down

0 comments on commit 134b1f3

Please sign in to comment.