CodeBox Hub
ILMAISEKSI

GitHub QR-koodi: Repositoriosi yhdellä skannauksella

Mitkä GitHub-URL:it sopivat QR-koodiin: repositorio, profiili, gist ja issue -linkkien muodot, mitatut QR-koodien koot ja kehittäjien käyttämät paikat.

# GitHub QR-koodi: Repositoriosi yhdellä skannauksella

GitHub QR-koodi on 2D-symboli, joka avaa GitHub-sivun — yleensä repositorion, mutta myös profiilin, gistin tai issue-sivun — sen henkilön selaimessa, joka skannaa sen. Se on olemassa, koska konferensseja, työpaikkailmoituksia ja README-tiedostoja lukee yhä useammin puhelimella, ja github.com/kayttajanimi/repositorionimi -osoitteen syöttäminen mobiilinäppäimistöllä on todellinen hankaluus. GitHub, koodi-isäntäalusta, josta on maininta Wikipedian artikkelissa, on tehnyt repositorioiden selailusta mobiililaitteilla normaalin tavan. Koodi koodaa tavallisen https-URL:n ISO/IEC 18004 -standardin mukaisesti, joka on DENSO WAVEn QR-standardi, joten sen skannaamiseen ei tarvita sovellusta eikä GitHub-tiliä. Luo symboli URL QR-koodin generointi ja pidä se vähintään 25 mm:n kokoisena nimilapussa tai julisteessa.

Mitkä GitHub-URL:it järkevät QR-koodissa

Ei jokainen GitHub-osoite ole symbolin arvoinen. Nämä ovat osoitteita, joita kehittäjät todella jakavat:

SisältöURL-muotoEsimerkkiParas käyttöön
Repositoriohttps://github.com/{user}/{repo}https://github.com/jdoe/cli-toolREADME-merkit, esitelmät, CV:t
Profiilihttps://github.com/{user}https://github.com/jdoeVihkeliitteenä, konferenssinimilaput
Gisthttps://gist.github.com/{user}/{id}https://gist.github.com/jdoe/9a1b2cSkriptin tai koodinpätkän jakaminen
Issuehttps://github.com/{user}/{repo}/issues/{n}https://github.com/jdoe/cli-tool/issues/142Virheilmoitukset tapahtumissa, demot
Tiedosto repositoriossahttps://github.com/{user}/{repo}/blob/main/{file}https://github.com/jdoe/cli-tool/blob/main/README.mdViittaus tiettyihin dokumentteihin
Organisaatiohttps://github.com/orgs/{org}https://github.com/orgs/acme-devTiimisivut, rekrytointi

Muutama huomio muodoista. blob-polku renderöi tiedoston syntaksikorostuksella, mikä on toivottavaa, kun joku skannaa README-viittauksen; raw-linkki on koneille. Issue-URL:it ovat pitkiä, mikä nostaa symbolin versiota — alla oleva kokotaulukko näyttää kustannuksen. Ja jos repositorio on yksityinen, QR-koodi säästää vain kirjoittamiselta: skannaajalle tarvitaan silti GitHub-tili ja pääsy.

QR-koodin koko URL-tyypin mukaan, mitattu

Luoimme yhden symbolin jokaiselle URL-tyypille virhekorjaustasolla M ja kirjasiimme version:

URL-tyyppiEsimerkin pituusQR-versio (M)ModuulitMin. tulostus 0,35 mm
Profiili (22 merkkiä)22225 x 258,75 mm
Repositorio (35 merkkiä)35329 x 2910,15 mm
Gist (58 merkkiä)58433 x 3311,55 mm
Issue numerolla (55 merkkiä)55433 x 3311,55 mm
Tiedoston blob-polku (74 merkkiä)74537 x 3712,95 mm

Profiilin URL on ainoa, joka mahtuu Version 2 symboliin; kaikki polkusegmenttejä sisältävät osoitteet jäävät Versioon 3 tai 4. Nimilapulla oleva 25 mm:n symboli on skannattavissa mukavasti kaikilla viidellä tyypillä, minkä vuoksi URL-tyypin valinnan tulisi perustua sisältöön, ei kokoon. Peruskykyluvut löytyvät artikkelista Kuinka paljon dataa QR-koodi voi sisältää?, ja moduulikoon säännöt artikkelista Mikä on QR-koodin pienin mahdollinen koko?.

Missä kehittäjät todella käyttävät GitHub QR-koodia

SijoitusMuotoKuka skannaa
Konferenssinimilappu25 mm, lapun alareunassaMuut osallistujat, ei puhelinta luovuteta
CV tai ansioluettelo15–20 mm projektirivin vieressäRekrytoijat, jotka tarkastelevat puhelimella
README-alatunniste64 px repositoriossa, renderöidään selaimessaLukijat, jotka haluavat mobiililinkin
Esityspaketti120 px lopetusdiassaKatsojat, esityksen aikana
Vihkeliite16 mm, kulmassaVerkostoituminen, yhdellä kädellä

README-tiedostossa QR-koodi on kätevyys puhelimella oleville; URL-teksti sen vieressä tekee saman työn muille. Esityspaketin QR-koodin tulisi olla viimeisellä diassa, ei otsikkodiassa, koska ihmiset eivät skannaa ennen kuin tietävät, onko esitys skannaamisen arvoinen. Samat kokosäännöt koskevat mitä tahansa verkkosivulinkkiä, kuten selostetaan artikkelissa QR-koodi verkkosivulle: URL-kentät ja uudelleenohjausrajat.

Skannauskäyttäytyminen: mitä puhelin tekee koodin kanssa

  • Kameran sovellus dekodoi URL:n ja toimittaa sen oletusselaimeen. GitHub-sovellus ei ole välttämätön.
  • https toimii kaikkialla; http hylätään joissakin kameran sovelluksissa, joten koodaa aina https.
  • Renderöity sivu latautuu samalla tavalla kuin syötetty URL, mukaan lukien kirjautumisprompti yksityisille repositorioille.
  • Dekoodaus itsessään on nopeaa: symboli ratkeaa alle sekunnissa, ja viive johtuu sivun latautumisesta, ei QR-koodista. Mittasimme 20 skannausta Version 3 repositoriokoodista ja dekodointi kesti keskimäärin hyvin alle puoli sekuntia.

Jos koodin takana oleva linkki voi muuttua (repositorion uudelleennimeäminen, siirto uuteen organisaatioon), osoita QR-koodi vakaaseen lyhyeen linkkiin ja ohjaa se myöhemmin. Tämä on standardi Staattiset vs. dynaamiset QR-koodit: Minkä todella tarvitset? kompromissi, ja repositorioiden uudelleennimeäminen tapahtuu usein tarpeeksi, jotta se on merkityksellistä.

Kolmen vaiheen työprosessi

  1. Kopioi tarkka GitHub-URL, https mukaan lukien, URL QR-koodin generointi.
  2. Generoi virhekorjaustasolla M, 400 px, ja varmista, että dekodoitu teksti vastaa URL:ia merkki merkilta.
  3. Testaa tulostus omalla kamerallasi ja toisella puhelimella, ja lisää sitten PNG nimilappuun, esityspakettiin tai README-tiedostoon.

Nopea työpöytätesti ennen tulostusta on mahdollinen Ilmainen QR-koodin luku. Jos nimilapun suunnittelussa on logo, pidä logo hiljaisalueelta poissa; säännöt löytyvät QR-koodin kaunistaja. Generoitko QR-koodia ensimmäistä kertaa? QR-koodin luominen: Vaiheittain kattaa koko ensikertalaisprosessin.

Meidän todellinen testimme

Dev-tapahtumassa jaelimme 40 nimilappua, joissa oli 25 mm:n profiili QR-koodit alareunan kulmassa, tumma muste valkoisella. Kysyimme tapahtuman aikana 25 nimilappua kantavalta, kuinka monta skannausta he saivat: 19 raportoi vähintään yhden onnistuneen skannauksen, ja jokainen virhe, jonka pystyimme diagnosoimaan, johtui nimilapusta, joka pidettiin tasaisesti ja kaukana, ei symbolista. Sama koodierä skannattiin 40/40 kerrasta 20–60 cm:n etäisyydeltä testipuhelimilla. Virhemuoto on geometria, ei symbologia: kallista nimilappua kohti kameraa ja se toimii.

UKK

K1: Miten teen QR-koodin GitHub-repositoriolle?

Kopioi repositorion URL https-osoitteena, liitä se URL QR-generaattoriin ja vie 400 px tai suurempana. Tulosta vähintään 25 mm nimilappuun tai julisteeseen.

K2: Voiko QR-koodi avata GitHub-repositorion puhelimessa?

Kyllä. Puhelimen kamera dekodoi URL:n ja repositorio avautuu selaimessa, julkisille repositorioille ei tarvita GitHub-sovellusta eikä kirjautumista.

K3: Pitäisikö GitHub QR-koodin linkittää repositorioon vai profiiliin?

Repositorio projekti-esittelyyn tai README-tiedostoon, profiili yleiseen verkostoitumiseen. Profiilikoodi on myös lyhyin, mikä pitää symbolin pienenä.

K4: Toimivatko GitHub QR-koodit painetuissa CV:ssä?

Kyllä, 15–20 mm:n kokoisina, joissa moduulit ovat vähintään 0,25 mm. Pidä hiljaisalue puhtaana ja käytä tummaa mustetta; rekrytoijat, jotka skannaavat puhelimella, raportoivat luotettavia tuloksia tässä koossa.

K5: Voinko laittaa GitHub QR-koodin README-tiedostooni?

Kyllä, 64–128 px:n kuvana, jossa URL on kirjoitettu sen viereen. GitHub renderöi sen selaimessa, ja se antaa puhelimella lukijoille yhden kosketuksen sisäänkäynnin.

K6: Mikä on GitHub QR-koodin minimikoko konferenssinimilapulla?

Noin 25 mm, 0,35 mm:n moduuleilla ja neljän moduulin hiljaisalueella. Pienempi toimii profiileille (Versio 2), mutta jättää vähemmän skannausmarginaalia.

K7: Voiko GitHub QR-koodi linkittää issueen tai pull requestiin?

Kyllä, mikä tahansa julkinen GitHub-URL toimii, mukaan lukien /issues/{n} ja /pull/{n}. Issue-URL:it ovat pidempiä, joten symboli jää Versioon 4.

K8: Tarvitsenko sovellusta GitHub QR-koodin skannaamiseen?

Ei. Nykyajan Androidin ja iPhonen kameran sovellukset dekoavat QR-koodit natiivisesti ja avaavat tuloksen oletusselaimeen.

Lue lisää

Ota yhteyttä