This is an automated email from the ASF dual-hosted git repository.
yuqi1129 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new f15d374bb7 [MINOR] docs: Clarify issue-linking syntax in
CONTRIBUTING.md and PR template (#13852)
f15d374bb7 is described below
commit f15d374bb720382b399e00a5220cc4cacc87a73e
Author: brucearctor <[email protected]>
AuthorDate: Sun Oct 25 23:35:02 2026 -0700
[MINOR] docs: Clarify issue-linking syntax in CONTRIBUTING.md and PR
template (#13852)
### What changes were proposed in this pull request?
1. Update `.github/PULL_REQUEST_TEMPLATE` to use `Fixes #<issue>`
instead of `Fix: #(issue)` (matching the `[#<issue>]` convention at the
top of the template).
2. Expand the issue-linking bullet under `## 🔃 Creating Pull Requests`
in `CONTRIBUTING.md` to explain the GitHub closing keyword syntax,
repeating the keyword when linking multiple issues (e.g., `Fixes #123,
fixes #456`), and not replacing the keyword with the issue type (e.g.,
`Improvement: #123`).
### Why are the changes needed?
1. Aligns `.github/PULL_REQUEST_TEMPLATE` with `CONTRIBUTING.md` and
matches line 2's `#<issue>` placeholder style, avoiding cases where
contributors keep literal parentheses from `#(issue)` (e.g., `Fix:
#(10602)`).
2. Clarifies in `CONTRIBUTING.md` how GitHub closing keywords work
(including repeating the keyword for multiple issues like `Fixes #123,
fixes #456` and not replacing `Fix:` with issue types like `Improvement:
#10272`), preventing merged PRs from leaving their linked issues open.
3. Remains compatible with `extract_issues` in
`dev/ci/label_fix_version.sh`.
Fixes: N/A
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
- `git diff --check`
- Verified against the `extract_issues` pattern in
`dev/ci/label_fix_version.sh`.
---------
Co-authored-by: Qi Yu <[email protected]>
---
.github/PULL_REQUEST_TEMPLATE | 2 +-
CONTRIBUTING.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 40407e970d..ca84c7a563 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -20,7 +20,7 @@
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, describe the bug.)
-Fix: #(issue)
+Fixes #<issue>
### Does this PR introduce _any_ user-facing change?
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 452c6f08ec..909a5cf28c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -203,7 +203,7 @@ Reviewing and triaging helps maintain the project. You can:
* Use feature branches
* Write clear commit messages and PR descriptions
-* Link to issues (e.g., `Fixes #123`)
+* Link to issues in the PR description using a [GitHub closing
keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
(e.g., `Fixes #123` or `Fix: #123`; for multiple issues, repeat the keyword
for each issue, e.g., `Fixes #123, fixes #456`). Do not replace the keyword
with the issue type (e.g., `Improvement: #123`), as that prevents GitHub from
automatically closing the issue.
* Respond to reviewer feedback
* Please add Copilot on the PR. Automatic review runs once when the PR is
marked ready; later pushes do not re-review, so add Copilot again after you
push. Treat Copilot comments as hints: implement the suggestion, or reply with
why you are not taking it. Human reviewers remain responsible for the merge
decision. Project-specific Copilot guidance lives in
[`.github/copilot-instructions.md`](.github/copilot-instructions.md).
