Skip to content

Commit abb4c61

Browse files
authored
workflow: add pull request template (#130)
1 parent d9b904d commit abb4c61

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Thanks for your PR, you're awesome! 👍
2+
3+
Please ensure you have read the [Contributing code](https://github.com/trpc-group/trpc-go/blob/main/CONTRIBUTING.md#contributing-code).
4+
5+
The PR title should be formatted as follows: `client: remove internal info`
6+
- The package name goes before the colon
7+
- The part after the colon uses the verb tense + phrase that completes the blank in,
8+
"This change modifies tRPC-Go to ___________"
9+
- Lowercase verb after the colon
10+
- No trailing period
11+
- Keep the title as short as possible. ideally under 76 characters or shorter.
12+
13+
Delete these instructions once you have read and applied them.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ The [benchstat](https://godoc.org/golang.org/x/perf/cmd/benchstat) tool is conve
9999
The special notation "Fixes #12345" associates the change with issue 12345 in the tRPC-Go issue tracker.
100100
When this change is eventually applied, the issue tracker will automatically mark the issue as fixed.
101101

102+
- If there is a corresponding issue, add either `Fixes #12345` or `Updates #12345` (the latter if this is not a complete fix) to this comment
103+
- If referring to a repo other than `trpc-go` you can use the `owner/repo#issue_number` syntax: `Fixes trpc-group/tnet#12345`
104+
102105

103106
## Miscellaneous topics
104107

CONTRIBUTING.zh_CN.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ tRPC-Go 中的提交消息遵循一套特定的约定,我们将在本节中讨
9191
特殊表示法 "Fixes #12345" 将变更与 tRPC-Go issue 跟踪器中的 issue 12345关联。
9292
当此变更最终应用时,issue 跟踪器将自动将该 issue 标记为已修复。
9393

94+
- 如果有相关 issue,请在此评论中添加 `Fixes #12345`` Updates #12345`(如果这不是完整的修复)
95+
- 如果涉及到的仓库不是 `trpc-go`,则可以使用 `owner/repo#issue_number` 语法:`Fixes trpc-group/tnet#12345`
96+
9497
## 其他主题
9598

9699
### 版权声明

0 commit comments

Comments
 (0)