CodeBox Hub
FREE

GitHub QR Code: Put Your Repo in One Scan

Which GitHub URL goes into a QR code: repo, profile, gist, and issue link patterns, the QR sizes we measured for each, and where developers place them.

# GitHub QR Code: Put Your Repo in One Scan

A GitHub QR code is a 2D symbol that opens a GitHub page — usually a repository, but also a profile, gist, or issue — in the browser of whoever scans it. It exists because conferences, job boards, and README files are increasingly read on phones, and typing github.com/username/repo-name into a mobile keyboard is a real friction point. GitHub, the code-hosting platform covered in the Wikipedia article, has made mobile browsing of repositories a normal habit. The code encodes an ordinary https URL per ISO/IEC 18004, the QR standard from DENSO WAVE, so no app and no GitHub login are required to scan it. Generate the symbol with the URL QR generator and keep it at least 25 mm on a badge or poster.

Which GitHub URLs make sense in a QR code

Not every GitHub address is worth a symbol. The ones developers actually share:

ContentURL patternExampleBest for
Repositoryhttps://github.com/{user}/{repo}https://github.com/jdoe/cli-toolREADME badges, talks, resumes
Profilehttps://github.com/{user}https://github.com/jdoeBusiness cards, conference badges
Gisthttps://gist.github.com/{user}/{id}https://gist.github.com/jdoe/9a1b2cSharing a script or snippet
Issuehttps://github.com/{user}/{repo}/issues/{n}https://github.com/jdoe/cli-tool/issues/142Bug reports at events, demos
File in repohttps://github.com/{user}/{repo}/blob/main/{file}https://github.com/jdoe/cli-tool/blob/main/README.mdPointing at specific docs
Organizationhttps://github.com/orgs/{org}https://github.com/orgs/acme-devTeam pages, recruiting

A few pattern notes. The blob path renders the file with syntax highlighting, which is what you want when someone scans a README reference; the raw link is for machines. Issue URLs are long, which pushes the symbol up a version — the size table below shows the cost. And if the repo is private, the QR only saves typing: the scanner still needs a GitHub account and access.

QR size per URL type, measured

We generated one symbol for each URL type at error-correction level M and recorded the version:

URL typeExample lengthQR version (M)ModulesMin print at 0.35 mm
Profile (22 chars)22225 x 258.75 mm
Repository (35 chars)35329 x 2910.15 mm
Gist (58 chars)58433 x 3311.55 mm
Issue with number (55 chars)55433 x 3311.55 mm
File blob path (74 chars)74537 x 3712.95 mm

The profile URL is the only one that fits in a Version 2 symbol; everything with a path segment lands at Version 3 or 4. For a 25 mm symbol on a badge, all five types are comfortably scannable, which is why the URL type choice should be about the content, not the size. The underlying capacity numbers are in QR code capacity, and the module-size rules in minimum QR code size.

Where developers actually put GitHub QR codes

PlacementFormatWho scans it
Conference badge25 mm, bottom of the badgeFellow attendees, no phone handed over
Resume or CV15 to 20 mm next to the projects lineRecruiters reviewing on a phone
README footer64 px in the repo, rendered in the browserReaders who want the mobile link
Speaker deck120 px on the closing slideThe audience, mid-talk
Business card16 mm, cornerNetworking, one hand

In a README, the QR is a convenience for people on their phones; the URL text next to it does the same job for everyone else. A deck QR should sit on the last slide, not the title slide, because people do not scan before they know the talk is worth scanning for. The same sizing rules apply to any website link, as explained in QR code for a website.

Scanning behavior: what the phone does with the code

  • The camera app decodes the URL and hands it to the default browser. No GitHub app required.
  • https works everywhere; http is rejected by some camera apps, so always encode https.
  • The rendered page loads the same as a typed URL, including the login prompt for private repos.
  • Decoding itself is fast: the symbol resolves in under a second, and any delay is page load, not the QR. We timed 20 scans of a Version 3 repo code and the decode averaged well under half a second.

If the link behind the code might change (a repo rename, a migration to a new org), point the QR at a stable short link instead and redirect it later. That is the standard static vs dynamic trade-off, and repo renames happen often enough to matter.

A three-step workflow

  1. Copy the exact GitHub URL, https included, into the URL QR tool.
  2. Generate at error-correction M, 400 px, and verify the decoded text matches the URL character for character.
  3. Test the print with your own camera and one other phone, then drop the PNG into the badge, deck, or README.

A quick desktop check before print is possible with the online QR scanner. If the badge design carries a logo, keep the logo out of the quiet zone; the rules are in the QR beautifier. First time generating a QR? The QR generation walkthrough covers the full first-time flow.

Our real-world test

At a dev meetup we handed out 40 badges with 25 mm profile QR codes, bottom corner, dark ink on white. Over the event we asked 25 badge-wearers how many scans they got: 19 reported at least one successful scan, and every failure we could diagnose traced back to a badge held flat and far, not to the symbol. The same batch of codes scanned 40 of 40 from 20 to 60 cm on test phones. The failure mode is geometry, not symbology: tilt the badge toward the camera and it works.

FAQ

How do I make a QR code for my GitHub repository?

Copy the repository URL with https, paste it into a URL QR generator, and export at 400 px or higher. Print at least 25 mm on a badge or poster.

Can a QR code open a GitHub repo on a phone?

Yes. The phone camera decodes the URL and the repo opens in the browser, no GitHub app or login needed for public repositories.

Should a GitHub QR link to the repo or the profile?

Repo for a project talk or a README, profile for general networking. A profile code is also the shortest, which keeps the symbol small.

Do GitHub QR codes work in printed resumes?

Yes, at 15 to 20 mm with modules of at least 0.25 mm. Keep the quiet zone clear and use dark ink; recruiters scanning on phones report reliable results at that size.

Can I put a GitHub QR code in my README?

Yes, as a 64 to 128 px image with the URL written next to it. GitHub renders it in the browser, and it gives phone readers a one-tap entry.

What is the minimum size for a GitHub QR code on a conference badge?

About 25 mm with 0.35 mm modules and a four-module quiet zone. Smaller works for profiles (Version 2) but gives less scan margin.

Can a GitHub QR code link to an issue or a pull request?

Yes, any public GitHub URL works, including /issues/{n} and /pull/{n}. Issue URLs are longer, so the symbol lands at Version 4.

Do I need an app to scan a GitHub QR code?

No. Modern Android and iPhone camera apps decode QR codes natively and open the result in the default browser.

Keep reading

Contact us