diff --git a/contribute-open-source/pull-request.md b/contribute-open-source/pull-request.md index fdde58f..5ed16dd 100644 --- a/contribute-open-source/pull-request.md +++ b/contribute-open-source/pull-request.md @@ -127,14 +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. 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} @@ -142,7 +159,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. :::