How can I use a link to source code in GitHub Issue? - github

Question

I want to reference certain lines from a file in a GitHub repository in an issue. How can I do this without copying and pasting manually? Can I use a link to the source code?
To clarify, here is the file that I want to reference code from:
mysource.py
1: def func1():
2: for i in range(10);
3: print 'hello world'
4:
5: def func2():
6: for i in range(10);
7: print 'hello world'
I want to quote lines 5 to 7 of the file in my issue like this:
5: def func2():
6: for i in range(10);
7: print 'hello world'

Answer 1

You can now do this by selecting a range of lines and using the create issue menu option:
Example
...resulting in:
Steps
Go to the source file
Select the range of lines (e.g., click the first line of interest, then shift + click the last line)
From the ... menu on the left, select create an issue
An issue page will appear with a link to the lines, which renders as view of the source code.

Answer 2

You can add the following hash-fragment.
https://github.com/username/repo/mysource.py#L5-L7
Just tried it without even knowing it was possible.

Answer 3

The key is to get a permalink to the code, that will be automatically converted to the code snippet by GitHub Markdown (GFM). After completing the steps below, the whole thing should look like this after you create an issue or comment:
Live example
Follow these steps:
Go to the page with source code that needs to be referenced. For example: https://github.com/roots/trellis-cli/blob/master/cmd/venv_hook.go
Click on the line number next to the respective code. The selected line should now be colored with yellow, and the three dots button should appear next to the line number, like that:
Tip: if you want to reference multiple lines of code, click on the first line number, then hold Shift and press the second line number.
Click on the three dots button, select "Copy permalink":
Go to the issue where you want to reference the code. Paste the permalink there. The link should look like that:
https://github.com/roots/trellis-cli/blob/a389115eb35e3c322e084183dc41497ffd67e7e0/cmd/venv_hook.go#L25-L27
Notice that the link to the source code now has a commit SHA in the URL instead of the branch name master.

Answer 4

No, this is not possible. However, you can create line comments on the Files Changed tab of pull requests which can reference issues through the standard # referencing.