Skip to content

add issue cross-reference guidance#43546

Merged
Sharra-writes merged 4 commits intogithub:mainfrom
XiaoPengMei:docs-issue-cross-referencing-42376
Mar 30, 2026
Merged

add issue cross-reference guidance#43546
Sharra-writes merged 4 commits intogithub:mainfrom
XiaoPengMei:docs-issue-cross-referencing-42376

Conversation

@XiaoPengMei
Copy link
Copy Markdown
Contributor

Closes #42376

Summary

  • add a short note to the general issue creation flow explaining how to cross-reference a related discussion

@welcome
Copy link
Copy Markdown

welcome bot commented Mar 26, 2026

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
issues/tracking-your-work-with-issues/using-issues/creating-an-issue.md fpt
ghec
ghes@ 3.20 3.19 3.18 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.20 3.19 3.18 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 26, 2026
@Sharra-writes
Copy link
Copy Markdown
Contributor

@XiaoPengMei I have confirmed this works, so I think this is probably all it needs. I'll get it merged when I'm released from the current deploy freeze.

@Sharra-writes Sharra-writes added ready to merge This pull request is ready to merge and removed triage Do not begin working on this issue until triaged by the team ready to merge This pull request is ready to merge labels Mar 27, 2026
@Sharra-writes Sharra-writes added this pull request to the merge queue Mar 30, 2026
Merged via the queue into github:main with commit 0c2b03a Mar 30, 2026
41 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

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're looking for your next contribution, check out our help wanted issues

@jsoref
Copy link
Copy Markdown
Contributor

jsoref commented Mar 30, 2026

Note that this isn't really great.

It doesn't explain that

https://github.com/check-spelling-sandbox/cautious-funicular-special-happiness/discussions/3

Will render as a link, but to get a pretty reference, you need to do:

- https://github.com/check-spelling-sandbox/cautious-funicular-special-happiness/discussions/3

And to get a pretty link for an organization discussion, you have to convert the link.

This won't work:

- https://github.com/orgs/community/discussions/191136#discussioncomment-16386875

You need to use:

- https://github.com/community/community/discussions/191136#discussioncomment-16386875

Samples

check-spelling-sandbox/cautious-funicular-special-happiness#3
https://github.com/orgs/community/discussions/191136#discussioncomment-16386875

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

creating-an-issue doesn't talking about cross-referencing / explain how to cross-reference

3 participants