Skip to content

chore: update template #1172

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

Merged
merged 1 commit into from
Jul 8, 2023
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--

🤭 感谢你的提交,请检查你的改动是否符合以下项目规范。

### 1. 格式化

我们项目中各种编程语言代码(包括文档)所采用的格式化工具不同,提交 pr 之前必须确保代码、文档正确格式化。

- .{md,js,ts,php,sql} 采用 prettier
- .{c,cpp,java} 采用 clang-format
- .{py} 采用 black
- .{go} 采用 gofmt
- 其它待完善

### 2. Git 提交信息

我们项目遵循 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#) 规范,我们希望你的提交信息尽可能与项目保持一致。

- 新增或修改题解:feat: add/update solution(s) to lc problem(s): No.xxxx
- 修复错误:fix: xxxx
- 日常维护:chore: xxx

### 3. 其它补充

新增题解及代码时,需要创建 Solution.xxx 源代码文件(如果已存在,请确认算法是否更优,是则覆盖已有算法代码),同时,需要在 README.md 以及 README_EN.md 中添加对应的代码片段(英文文件中不要出现中文注释)

另外,编码风格(比如变量、函数的命名),尽量跟项目已有代码保持一致。

-->
8 changes: 1 addition & 7 deletions .github/PULL_REQUEST_TEMPLATE/template_en.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
[中文模板](?quick_pull=1&template=pull_request_template.md)

---

<!--
🤭 Thank you for your contribution. Please check if your changes comply with the following project specifications.
-->

<!--
🤭 Thank you for your contribution. Please check if your changes comply with the following project specifications.

### 1. Formatting

Expand Down
34 changes: 4 additions & 30 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,6 @@
[English Template](?quick_pull=1&template=template_en.md)
请切换到 `Preview` 选项卡选择对应的模板:

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

<!--
🤭 感谢你的提交,请检查你的改动是否符合以下项目规范。
-->

<!--
### 1. 格式化

我们项目中各种编程语言代码(包括文档)所采用的格式化工具不同,提交 pr 之前必须确保代码、文档正确格式化。

- .{md,js,ts,php,sql} 采用 prettier
- .{c,cpp,java} 采用 clang-format
- .{py} 采用 black
- .{go} 采用 gofmt
- 其它待完善

### 2. Git 提交信息

我们项目遵循 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#) 规范,我们希望你的提交信息尽可能与项目保持一致。

- 新增或修改题解:feat: add/update solution(s) to lc problem(s): No.xxxx
- 修复错误:fix: xxxx
- 日常维护:chore: xxx

### 3. 其它补充

新增题解及代码时,需要创建 Solution.xxx 源代码文件(如果已存在,请确认算法是否更优,是则覆盖已有算法代码),同时,需要在 README.md 以及 README_EN.md 中添加对应的代码片段(英文文件中不要出现中文注释)

另外,编码风格(比如变量、函数的命名),尽量跟项目已有代码保持一致。 -->
* [中文模板](?quick_pull=1&template=template.md)
* [English Template](?quick_pull=1&template=template_en.md)