Update linking-a-pull-request-to-an-issue.md

[casals]

Why:

Fixes #165 .

What's being changed:

I added a Note box at the top of the document, and a reference to it at the top of the document - should be enough warning without disrupting the rest of the text. Also changed the introductory line in the "Linking a pull request(...)" section as suggested by the author/PR reviewer:

• Original sentence: "You can link a pull request to an issue by using a supported keyword in the pull request's description."
• Modified sentence: "You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message (please note that the PR must be on the default branch)."

Check off the following:

• All of the tests are passing.
• I have reviewed my changes in staging.
• For content changes, I have reviewed the localization checklist
• For content changes, I have reviewed the Content style guide for GitHub Docs.

[janiceilene]

Amazing @casals! I'll send this one to @github/docs-content-core team to review, too 👍

[atlslscsrv-app]

@atlslscsrv-app

[felicitymay]

Hi - thanks for addressing this issue, it's great to have this topic improved ✨

I'm a little puzzled by:

I added a Note box at the end of the document, and a reference to it at the top of the document

On staging, the note box appears to be at the start of the topic. Given that our search links to each H3 within the topic, I'm wondering if the note would be better placed within the "Linking a pull request to an issue using a keyword" section, maybe straight after the bulleted list of special terms. Otherwise people who go straight to that section will miss the note. What do you think?

If we did move the note box, then probably we should expand the first sentence of the topic: "You can link an issue to a pull request manually or using a supported keyword in the pull request description." to mention the default branch.

[casals]

Hey @felicitymay - what happened here was: I had just submitted a number of PRs that involved including a Note box at the end of the document. During the review of the first of these PRs, one of the requested changes was to move the Note box to the top of the page, since that's the standard style/practice. In order to maintain consistency, I moved the (new) Note box to the top of the document in all of my PRs - but forgot to change the description here, sorry.

All that being said, I think we can go with your latter suggestion: keep the box at the topic of the document + expand the first sentence of the topic. In fact, this sentence was already extended from its original version. I'm updating the PR description with these changes.

[felicitymay]

Thanks 👍🏻 🚀

[felicitymay]

Thanks for responding so quickly - it's much appreciated. I've added the automerge label and will check back to make sure that all's well.

[felicitymay]

Ah. Okay. Will check back to see when the tests have passed and merge.

[github-actions]

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

If you haven't already, you can add yourself to the list of contributors by creating a new comment in this PR using these instructions. Thanks again! ✨