Issues, Pull Requests and Discussions¶
This page lists all features that can be used across all issues, Pull requests and Discussions on GitHub.
General features are supported.
Table of Contents¶
MkDocs Extensions used
GitHub automatically shortens/alters a list of specific URL-patterns to have it more easy to read.
Posting a commit URL will automatically shorten it depending on some conditions.
When the URL points to a commit in the same repo, will it be changed to the first 7 characters of the commit SHA.
However, when the URL points to a commit of a separate repository, will the resulting text be in the form of
/// detail | Supported formats The following formats can be used to generate a link to a specific commit within an issue, Pull request or discussion:
:commitwhich is the full (or shortened) Commit has within the same repository.
:user@:commitwhich links to a commit made by
:user/:repo@:commitwhich links to a commit made in a specific repository
:useron GitHub. ///
Issues and Pull requests¶
You can link to issues and Pull requests in various ways.
Issue/Pull request number (Same repository):
Issue/Pull request number (External repository)
When you link to a section of a file in a specific commit will GitHub show the targeted content in the Issue/Pull request.
Line 1 in
When using inline code can you use a hashtag, followed by a hexadecimal color value (i.e.
#ffffff) and GitHub will automatically add a small square in the provided color to it.
I like green: `#16c60c`
I like green:
Advanced (task) lists¶
Whenever you link an issue, Pull request or Discussion in a list or Task list will GitHub automatically display the title, id and the current state of the issue, Pull request or Discussion.
Whenever a issue or Pull request is linked in a task list and said issue/Pull request is closed or merged will the corresponding task list entry get "checked".
As of right now are links to org-level discussions (
https://github.com/orgs/:org/discussions/:number) not working.
You can bypass this limitation by removing
/orgs and appending the repo name after
:org/ followed by a forward slash.