plots2
plots2 copied to clipboard
publiclab
[Welcoming] Help add code links to existing issues
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:
https://github.com/publiclab/plots2/labels/add-code-links
If those all have links, try some at https://github.com/publiclab/plots2/labels/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! 🎉 👍 🎈
I am adding this issue to the task list in #3276 under the section Outreach/Research: community management, marketing, or studying problems and recommending solutions
Hi! I tried looking into adding the links for #3451, however, I am not entirely sure where to look within the various files/folders and had little luck. Any tips?
Hi, @mcblake -- thanks! It looks like you may need to ask the author of that issue what page on PublicLab.org they've taken a screen shot of. I wasn't able to see that exact view anywhere... but if it's at the bottom of a list of notes, and above the pagination widget, maybe it's this? https://github.com/publiclab/plots2/blob/7896dfa2fab442088022400fb676aae289a120f4/app/views/notes/_notes.html.erb#L61
For what it's worth, i think that was a tough one to find links for. Many others may be easier!
yes, go ahead! :-)
On Wed, Sep 26, 2018 at 6:04 PM Cameron Blake [email protected] wrote:
Would a comment be the most appropriate way of asking the author?
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/publiclab/plots2/issues/3424#issuecomment-424884851, or mute the thread https://github.com/notifications/unsubscribe-auth/AABfJzf822AE6Blsi-7Xk-PqgSPwzMz1ks5ue_nLgaJpZM4W3OUm .
Published
On Sun, Dec 8, 2019 at 6:10 AM Sasha Boginsky [email protected] wrote:
Uploaded to GCI dashboard
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/publiclab/plots2/issues/3424?email_source=notifications&email_token=AFAAEQZIODACEHEM4LSNVR3QXQ67BA5CNFSM4FW44UTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGGS3EA#issuecomment-562900368, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFAAEQ5OSU2HESQSJ5L2VCTQXQ67BANCNFSM4FW44UTA .