Description
Contributors can help with our ongoing work to welcome newcomers and to produce more welcoming first timers only issues by adding URLs leading to specific lines of code on open issues.
This will help newcomers get started in a codebase they may not be familiar with! 🔍 🕵️
Find issues needing code links
To help out, find issues tagged with add-code-links:
If those all have links, try some at
fto-candidate
Find the right code link!
We need to show newcomers where in the code to look! Not every issue will have a clear concrete code change, but many do, and especially ones marked as good "first-timers-only" candidates, or fto-candidates.
To find where the change needs to be made, start navigating here: https://github.com/publiclab/plots2/tree/master/ (or in the /app/ folder for most things!)
Once you've found the right file, find the right line of code, and click the line number to make a permalink to that line:
Excerpts
Just a link to the right line is good enough! But if you want to excerpt the line in an issue or comment, you can click the ... menu and get a permalink.
The copied link there will actually insert the code in a little embedded widget, like this:
https://github.com/publiclab/plots2/blob/master/app/views/layouts/_header.html.erb#L121
Code segments
After clicking a line of code, it highlights in yellow. Using the shift key, you can then select a second line and it'll highlight a range, which you can also get a permalink for.
https://github.com/publiclab/plots2/blob/master/app/views/layouts/_header.html.erb#L121-123
Paste the code
Put it into the original issue so that people can find where to make the changes! Sometimes it'll take a few different lines of code to orient someone. That's fine!
This is REALLY HELPFUL, so thanks a ton for taking this on! 🎉 👍 🎈