Skip to content

Commit bacda30

Browse files
authored
chore: update pull request template (#1170)
1 parent ff20df9 commit bacda30

File tree

3 files changed

+42
-37
lines changed

3 files changed

+42
-37
lines changed

.github/PULL_REQUEST_TEMPLATE/template.md

-29
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/template_en.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
<!– 🤭 Thank you for your contribution. Please check if your changes comply with the following project specifications. –>
1+
[中文模板](?quick_pull=1&template=pull_request_template.md)
22

3-
[中文模板](?quick_pull=1&template=template.md)
3+
---
4+
5+
<!--
6+
🤭 Thank you for your contribution. Please check if your changes comply with the following project specifications.
7+
-->
8+
9+
<!--
410
511
### 1. Formatting
612
@@ -12,7 +18,7 @@ We use different formatting tools for various programming languages (including d
1218
- .{go} use gofmt
1319
- Others to be improved
1420
15-
### 2. Commit msg
21+
### 2. Git Commit Message
1622
1723
Our project follows the [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#). We hope that your submission information is as consistent as possible with the project.
1824
@@ -24,4 +30,6 @@ Our project follows the [AngularJS Git Commit Message Conventions](https://docs.
2430
2531
When adding solutions and code, you need to create a Solution.xxx source code file (if it already exists, please confirm whether the algorithm is better, if yes, overwrite the existing algorithm code), and at the same time, you need to add the corresponding code snippets in README.md and README_EN.md (do not have Chinese comments in the English file)
2632
27-
In addition, the coding style (such as the naming of variables and functions) should be as consistent as possible with the existing code in the project.
33+
In addition, the coding style (such as the naming of variables and functions) should be as consistent as possible with the existing code in the project.
34+
35+
-->

.github/pull_request_template.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
1-
请切换到 `Preview` 选项卡选择对应的模板:
1+
[English Template](?quick_pull=1&template=template_en.md)
22

3-
> Please go the the `Preview` tab and select the appropriate sub-template:
3+
---
44

5-
* [中文模板](?quick_pull=1&template=template.md)
6-
* [English Template](?quick_pull=1&template=template_en.md)
5+
<!--
6+
🤭 感谢你的提交,请检查你的改动是否符合以下项目规范。
7+
-->
8+
9+
<!--
10+
### 1. 格式化
11+
12+
我们项目中各种编程语言代码(包括文档)所采用的格式化工具不同,提交 pr 之前必须确保代码、文档正确格式化。
13+
14+
- .{md,js,ts,php,sql} 采用 prettier
15+
- .{c,cpp,java} 采用 clang-format
16+
- .{py} 采用 black
17+
- .{go} 采用 gofmt
18+
- 其它待完善
19+
20+
### 2. Git 提交信息
21+
22+
我们项目遵循 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#) 规范,我们希望你的提交信息尽可能与项目保持一致。
23+
24+
- 新增或修改题解:feat: add/update solution(s) to lc problem(s): No.xxxx
25+
- 修复错误:fix: xxxx
26+
- 日常维护:chore: xxx
27+
28+
### 3. 其它补充
29+
30+
新增题解及代码时,需要创建 Solution.xxx 源代码文件(如果已存在,请确认算法是否更优,是则覆盖已有算法代码),同时,需要在 README.md 以及 README_EN.md 中添加对应的代码片段(英文文件中不要出现中文注释)
31+
32+
另外,编码风格(比如变量、函数的命名),尽量跟项目已有代码保持一致。 -->

0 commit comments

Comments
 (0)