Skip to content

Commit

Permalink
workflow: add pull request template (#130)
Browse files Browse the repository at this point in the history
  • Loading branch information
liuzengh authored Nov 1, 2023
1 parent d9b904d commit abb4c61
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Thanks for your PR, you're awesome! 👍

Please ensure you have read the [Contributing code](https://github.com/trpc-group/trpc-go/blob/main/CONTRIBUTING.md#contributing-code).

The PR title should be formatted as follows: `client: remove internal info`
- The package name goes before the colon
- The part after the colon uses the verb tense + phrase that completes the blank in,
"This change modifies tRPC-Go to ___________"
- Lowercase verb after the colon
- No trailing period
- Keep the title as short as possible. ideally under 76 characters or shorter.

Delete these instructions once you have read and applied them.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ The [benchstat](https://godoc.org/golang.org/x/perf/cmd/benchstat) tool is conve
The special notation "Fixes #12345" associates the change with issue 12345 in the tRPC-Go issue tracker.
When this change is eventually applied, the issue tracker will automatically mark the issue as fixed.

- 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
- If referring to a repo other than `trpc-go` you can use the `owner/repo#issue_number` syntax: `Fixes trpc-group/tnet#12345`


## Miscellaneous topics

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

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

## 其他主题

### 版权声明
Expand Down

0 comments on commit abb4c61

Please sign in to comment.