What this is
A sandbox issue. The whole point is to give you something safe to point gem-contribute fix and gem-contribute submit at so you can practice the loop end-to-end before doing it for real.
You won't break anything. The PR you open against this issue isn't expected to be merged as-is — it just exists so you can see the whole flow work. (If your entry is well-formed, it may actually land. See the world-map note below.)
Try it
gem-contribute fix gem-contribute/<this-issue-number>
That'll fork the repo, clone your fork, create a gem-contribute/issue-<n> branch, and cd is yours from there.
The trivial change to make
Open KICKED_THE_TIRES.yml and append an entry at the bottom:
- handle: your-github-handle
date: YYYY-MM-DD
note: "one-line freeform message (optional)"
location: "City, Region, Country" # optional
That's it. Commit with a one-liner like Add @your-handle to KICKED_THE_TIRES.
About the world-map angle
Ratatui (which we'll use via Rooibos for the eventual TUI — see #2) has a world-map widget. The longer-term plan is a TUI view that plots everyone in this file on the map. Providing a location string puts you on it; the geocoding script (added when the world-map view lands) turns the string into coordinates.
"US" works for country-level rendering. "Asheville, NC, US" gets you a city-level pin. Use whatever precision you're comfortable with.
Then submit
Your browser will open to GitHub's PR compare page with the title and body pre-filled. Hit Create pull request.
What happens to the PR
Well-formed YAML additions will be merged so the file actually grows over time and the future world-map view has data. Malformed PRs (broken YAML, duplicate entries) will get a friendly comment and stay open until fixed or closed. Either way, you've now done the full open-source-contribution loop against a real repo.
What if I'm at the workshop
This is the warm-up. After you've kicked the tires here and the loop is in your fingers, pick up issue #1 (the real workshop task) and do it for keeps.
Acceptance criteria for the maintainer (me)
What this is
A sandbox issue. The whole point is to give you something safe to point
gem-contribute fixandgem-contribute submitat so you can practice the loop end-to-end before doing it for real.You won't break anything. The PR you open against this issue isn't expected to be merged as-is — it just exists so you can see the whole flow work. (If your entry is well-formed, it may actually land. See the world-map note below.)
Try it
That'll fork the repo, clone your fork, create a
gem-contribute/issue-<n>branch, andcdis yours from there.The trivial change to make
Open
KICKED_THE_TIRES.ymland append an entry at the bottom:That's it. Commit with a one-liner like
Add @your-handle to KICKED_THE_TIRES.About the world-map angle
Ratatui (which we'll use via Rooibos for the eventual TUI — see #2) has a world-map widget. The longer-term plan is a TUI view that plots everyone in this file on the map. Providing a
locationstring puts you on it; the geocoding script (added when the world-map view lands) turns the string into coordinates."US"works for country-level rendering."Asheville, NC, US"gets you a city-level pin. Use whatever precision you're comfortable with.Then submit
Your browser will open to GitHub's PR compare page with the title and body pre-filled. Hit Create pull request.
What happens to the PR
Well-formed YAML additions will be merged so the file actually grows over time and the future world-map view has data. Malformed PRs (broken YAML, duplicate entries) will get a friendly comment and stay open until fixed or closed. Either way, you've now done the full open-source-contribution loop against a real repo.
What if I'm at the workshop
This is the warm-up. After you've kicked the tires here and the loop is in your fingers, pick up issue #1 (the real workshop task) and do it for keeps.
Acceptance criteria for the maintainer (me)
KICKED_THE_TIRES.ymland ship a geocoding script that fills in coordinates from the location strings.