From 8c76e6234df2f4ba4b6fff164a5243f2054a46b2 Mon Sep 17 00:00:00 2001 From: bluedotblue <121519363+bluedotblue@users.noreply.github.com> Date: Mon, 18 May 2026 12:10:18 -0700 Subject: [PATCH 1/3] Updated PR submission guidelines with issue references Emphasize including issue references in PR descriptions for closure. closes #142 --- contribute-open-source/pull-request.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contribute-open-source/pull-request.md b/contribute-open-source/pull-request.md index fdde58f..b120759 100644 --- a/contribute-open-source/pull-request.md +++ b/contribute-open-source/pull-request.md @@ -127,8 +127,9 @@ You can also click on the commit titles to see the specific changes in each comm Once you've reviewed your PR and everything looks good, it's time to submit it. -Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. When you have added your -title and description, click on “Create Pull Request” one more time to submit the PR. +Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #` issue number or `addresses #` issue number so once the maintainer merges your PR, Github will close the issue number. + +When you have added your title and description, click on “Create Pull Request” one more time to submit the PR. > ** Social cue:** > A **clear, descriptive PR title** helps maintainers quickly understand your changes. @@ -142,7 +143,6 @@ Note that your pull request can be modified at any time, but do so cautiously. - You can modify the title and description of your pull request even after you've submitted it. - New commits to your working branch will be visible in your open PR until they are merged. -- Any changes made to it will potentially delay a review from maintainers. It's best to submit the PR, review it, and leave it unchanged until you get feedback. ::: From 02ad14701543447c62d4ef21b9cf45746c602e5d Mon Sep 17 00:00:00 2001 From: Inessa Pawson Date: Tue, 22 Sep 2026 13:27:05 -0400 Subject: [PATCH 2/3] Address review feedback --- contribute-open-source/pull-request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contribute-open-source/pull-request.md b/contribute-open-source/pull-request.md index b120759..f6aa1ac 100644 --- a/contribute-open-source/pull-request.md +++ b/contribute-open-source/pull-request.md @@ -127,7 +127,7 @@ You can also click on the commit titles to see the specific changes in each comm Once you've reviewed your PR and everything looks good, it's time to submit it. -Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #` issue number or `addresses #` issue number so once the maintainer merges your PR, Github will close the issue number. +Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #IssueNumber` or `addresses #IssueNumber` so once the maintainer merges your PR, GitHub will close the issue automatically. When you have added your title and description, click on “Create Pull Request” one more time to submit the PR. From 2d4579b3b9df4e4d0a90aeeea7cae63949c1388e Mon Sep 17 00:00:00 2001 From: Inessa Pawson Date: Tue, 22 Sep 2026 21:50:29 -0400 Subject: [PATCH 3/3] Clarify GitHub issue closing keywords --- contribute-open-source/pull-request.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/contribute-open-source/pull-request.md b/contribute-open-source/pull-request.md index f6aa1ac..5ed16dd 100644 --- a/contribute-open-source/pull-request.md +++ b/contribute-open-source/pull-request.md @@ -127,15 +127,31 @@ You can also click on the commit titles to see the specific changes in each comm Once you've reviewed your PR and everything looks good, it's time to submit it. -Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #IssueNumber` or `addresses #IssueNumber` so once the maintainer merges your PR, GitHub will close the issue automatically. - -When you have added your title and description, click on “Create Pull Request” one more time to submit the PR. +Add a descriptive title and write a brief description of your changes. Pull request +titles should be concise and descriptive of the content in the pull request. > ** Social cue:** > A **clear, descriptive PR title** helps maintainers quickly understand your changes. > A good title is specific: **"Fix typo in README"** is better than **"Updated file"**. > Your description should also **explain why** the change was made. +If your pull request resolves an existing issue, you can link the PR to that issue +in the description. To have GitHub automatically close the issue when the PR is merged, +use one of GitHub's closing keywords followed by the issue number: + +- `close`, `closes`, or `closed` +- `fix`, `fixes`, or `fixed` +- `resolve`, `resolves`, or `resolved` + +For example: `closes #123`. + +You can also use wording such as `addresses #123` to reference an issue, but this +only creates a link between the pull request and the issue. It does not automatically +close the issue when the PR is merged. + +When you have added your title and description, click on “Create Pull Request” one more +time to submit the PR. + If you go to the parent repository, you will see the PR listed there. :::{tip}