Faça um QR code para um perfil ou repo do GitHub

Cole o endereço, deixe o código com a cara do seu adesivo ou slide e baixe pronto para impressão - apontado para uma URL que ainda vai resolver depois da próxima renomeação.

1 Conteúdo
https://
Sem cadastro QR codes ilimitados Sem marca d'água Free high-resolution downloads
2 Design
Forma
Padrão
Olhos
3 Prévia
Copiado!

O que é um QR code do GitHub?

Um QR code do GitHub é um QR code que guarda um endereço do github.com - um perfil, um repositório, uma release, um gist ou um arquivo num commit específico. Ao escanear, essa página abre no navegador do celular. O GitHub não exige app para ler um repositório, então o escaneamento funciona em qualquer celular.

O designer do KoloQR com um QR code sendo estilizado - forma, cores e logo central

Qual URL do GitHub deve ir no código

O GitHub tem vários endereços para a mesma coisa, e eles envelhecem em ritmos bem diferentes:

  • github.com/owner/repo/releases/latest - sempre redireciona para a release publicada mais recente. Imprima isso em hardware ou documentação, em vez de um número de versão que estará errado em um mês.
  • github.com/owner/repo/blob/<commit>/caminho - um link permanente para um arquivo como ele estava num commit. Apertar y na página de um arquivo reescreve a URL de branch nesse formato, e é o único link de arquivo que não apodrece.
  • github.com/owner/repo/blob/main/README.md - um link de branch. Conveniente, mas mostra o que a main tiver na hora do escaneamento, o que para uma referência impressa pode ser anos de mudanças depois.

O GitHub mantém redirecionamentos quando um repositório ou uma conta é renomeada, então um código impresso não morre necessariamente numa renomeação - mas esse redirecionamento depende de o nome antigo continuar sem dono, e um nome de usuário liberado pode ser registrado por outra pessoa. Para qualquer coisa impressa em volume, isso é motivo para codificar uma URL curta num domínio que você controla e apontá-la para o GitHub, de modo que uma mudança custe uma edição de redirecionamento em vez de uma reimpressão.

O que o escaneamento realmente abre num celular

A página de um repositório no celular é uma coluna estreita: a lista de arquivos e, abaixo, o README renderizado. Isso é legível, e é por isso que um código num adesivo de conferência ou na serigrafia de uma placa de desenvolvimento funciona. Duas coisas valem saber antes de imprimir. Um repositório privado mostra um 404 em vez de um pedido de login para quem não está autenticado, então um código apontando para trabalho privado parece quebrado em vez de protegido - teste de um celular deslogado. E uma URL de arquivo bruto em raw.githubusercontent.com baixa ou exibe texto puro em vez de abrir o repositório, o que serve para um arquivo de configuração e não serve para nada que uma pessoa deva ler.

Gerar QR code
Um celular lendo um QR code impresso para testar antes da tiragem

Onde os QR codes do GitHub são usados

Um código num objeto físico é o caminho mais curto entre hardware, papel ou um palco e o código-fonte por trás deles:

Adesivos e crachás de conferência

Um adesivo com código ganha de um nome de repositório dito no palco e lembrado pela metade no caminho de casa.

Hardware e placas de desenvolvimento

Um código serigrafado na placa ou impresso na caixa aponta para o repositório do firmware e para a última release, por toda a vida do dispositivo.

Documentação e manuais impressos

Um manual fica desatualizado no dia em que é impresso. Um código para a pasta de docs do repositório é a versão que não fica.

Slides e materiais de workshop

Um código no último slide, apontado para um link permanente, para o exemplo que as pessoas copiam ser o exemplo que viram.

Cartões de visita de pessoas desenvolvedoras

Um código de perfil carrega o trabalho em si em vez de uma descrição dele, que é o ponto do cartão.

Pôsteres em hackathons e demo days

Um jurado ou visitante escaneia o pôster e já está com o projeto aberto antes de chegar à mesa seguinte.

Como criar um QR code do GitHub

Do repositório ao adesivo impresso em quatro passos:

Gerar QR code
  1. 1

    Escolha a URL que envelhece melhor

    Um perfil para um cartão, /releases/latest para hardware e manuais, um link permanente de commit para um trecho de código. Evite links de branch e números de versão em tudo que for impresso.

  2. 2

    Confirme que ela resolve deslogado

    Abra a URL numa janela anônima. Um repositório privado devolve 404 em vez de um pedido de login, e é isso que seu leitor vai ver.

  3. 3

    Cole o link e desenhe o código

    Escolha o tipo URL e cole o endereço, depois escolha forma e cores. Módulos escuros sobre fundo claro aguentam um adesivo fosco melhor que um par invertido.

  4. 4

    Teste e exporte

    Escaneie de um celular e depois exporte SVG ou PDF para adesivos e serigrafia, e PNG para slides.

O gerador do KoloQR com um QR code sendo desenhado e pronto para baixar

Qual formato de arquivo você deve baixar?

O KoloQR exporta seu QR code do GitHub em três formatos. Escolha pelo lugar onde ele vai aparecer:

  • PNG para slides, READMEs e sites de documentação, onde o código aparece num tamanho fixo.
  • SVG para adesivos, artes de serigrafia e manuais impressos - tudo que é ampliado sem amolecer as bordas.
  • PDF para entregar a uma gráfica de adesivos ou a um fabricante de placas com qualidade pronta para impressão.

Nesta página, o que vale vigiar é o tamanho da carga. github.com/owner tem cerca de 25 caracteres e imprime pequeno sem problema; um link permanente de commit para um arquivo lá no fundo da árvore pode passar de 100, e isso pede um símbolo maior ou um adesivo maior. Se um link permanente longo tiver que ir em algo do tamanho de uma unha, coloque um redirecionamento curto no seu domínio na frente dele.

Gerar QR code

Boas práticas para QR codes do GitHub

Um link impresso para uma base de código tem um trabalho que o código em si não faz: continuar verdadeiro depois.

  • Imprima /releases/latest, não um número de versão

    Esse endereço sempre redireciona para a release publicada mais recente, então um manual ou uma etiqueta de dispositivo nunca nomeia uma versão já superada.

  • Use links permanentes de commit para trechos de código

    Um link para um arquivo numa branch mostra o que aquela branch tiver na hora do escaneamento. Um link permanente de commit mostra o que você imprimiu ao lado.

  • Confira se repositórios privados devolvem 404

    O GitHub não pede login a quem não pode ver um repositório. Um código para trabalho privado parece quebrado para todo mundo fora da organização.

  • Não conte com redirecionamentos de renomeação em impressão de vida longa

    Renomear um repositório ou conta deixa um redirecionamento, mas só enquanto o nome antigo continuar sem dono. Serigrafia e embalagem sobrevivem a essa garantia.

  • Mantenha a URL curta o bastante para a superfície

    Uma URL de perfil imprime tranquila a 15 mm. Um link permanente profundo no mesmo tamanho é um símbolo mais denso nos mesmos milímetros quadrados, e é aí que os escaneamentos começam a falhar.

  • Prefira a página do repositório a um arquivo bruto

    Um link raw.githubusercontent.com entrega ao celular texto puro ou um download. A página do repositório renderiza o README, que é o que a pessoa escaneou para ver.

  • Rotule para onde o código leva

    “Firmware e documentação” ou “código desta palestra” ao lado do código é a diferença entre um escaneamento e um dar de ombros.

  • Cuidado com o contraste em adesivos escuros

    Módulos escuros sobre fundo claro é o que as câmeras esperam. Se o adesivo precisa ser escuro, teste a versão invertida em vários celulares antes de encomendar a tiragem.

  • Proteja a zona de silêncio

    Quatro módulos de margem livre em cada lado - fácil de perder num adesivo pequeno em que a arte vai até a linha de corte.

  • Dimensione pela distância

    Cerca de um décimo da distância de leitura: uns 2 cm num adesivo de notebook, uns 20 cm num pôster lido a 2 metros.

Por que seu QR code do GitHub não funciona

O padrão raramente é o problema nesta página. A URL por trás dele geralmente é - seja pelo que ela aponta, seja pelo tamanho que tem.

  • O escaneamento mostra uma página 404

    Causa
    O repositório é privado, ou foi renomeado ou apagado e o nome antigo já foi tomado por outra pessoa, o que remove o redirecionamento.
    Solução
    Torne o repositório público, ou aponte o código para um perfil ou uma página de documentação pública. Para impressão em volume, codifique um redirecionamento no seu domínio para o destino continuar editável.
  • O código não escaneia num adesivo pequeno

    Causa
    Foi codificado um link permanente profundo ou um caminho de arquivo longo, então o símbolo carrega muito mais módulos do que um adesivo de 15 mm consegue resolver.
    Solução
    Encurte o destino - o perfil, a raiz do repositório ou /releases/latest - ou coloque uma URL curta do seu domínio na frente da longa, e gere de novo.
  • O escaneamento baixa um arquivo em vez de abrir uma página

    Causa
    A URL é um endereço raw.githubusercontent.com, que serve o arquivo em si e não a página renderizada do GitHub.
    Solução
    Codifique o endereço github.com/owner/repo/blob/... no lugar. Deixe links brutos para máquinas - uma configuração que um script busca - e não para uma pessoa com uma câmera.
  • O código aponta para uma versão antiga do projeto

    Causa
    Foi codificada a URL de uma release marcada ou um link de branch, e o projeto seguiu em frente. O código está fazendo exatamente o que mandaram.
    Solução
    Reimprima com /releases/latest para downloads, ou a raiz do repositório para o código-fonte. Os dois acompanham o projeto em vez de prendê-lo ao dia em que a arte foi feita.

Ainda não sabe se o problema é o arquivo ou a impressão? Solte a imagem exportada no scanner de QR code: se ela decodifica no computador e não no papel, o problema entrou depois do arquivo.

Questions? Answered

Um QR code do GitHub guarda um endereço do github.com - perfil, repositório, release ou arquivo num commit específico. Ao escanear, essa página abre no navegador do celular. Não é preciso app nem conta para ler um repositório público.

Um perfil para cartão de visita, github.com/owner/repo/releases/latest para hardware e manuais, e um link permanente de commit para um trecho de código. Evite links de branch e versões fixas em material impresso.

O GitHub redireciona o endereço antigo para o novo, então o código impresso costuma continuar funcionando - mas só enquanto o nome antigo continuar sem dono. Se outra pessoa registrar, o redirecionamento acaba.

Pode, mas quem está deslogado recebe um 404 em vez de um pedido de login, então o código parece quebrado para todo mundo fora da organização. Aponte material impresso público para páginas públicas.

Codifique github.com/owner/repo/releases/latest. O GitHub redireciona para a release publicada mais recente, então um código impresso num dispositivo ou manual nunca nomeia uma versão superada.

Uma URL de perfil ou repositório - cerca de 25 a 40 caracteres - imprime confiável a partir de uns 15 mm. Um link permanente longo de commit precisa de um símbolo maior, então dê mais espaço ou encurte o destino antes.

Porque ele codifica uma URL raw.githubusercontent.com, que serve o arquivo em si. Use o endereço github.com/owner/repo/blob/... quando quem vai ler a página é uma pessoa e não uma máquina buscando o arquivo.

Pode - exporte PNG e commite como qualquer outra imagem. Vale a pena quando o README documenta hardware, para o objeto impresso e o repositório levarem o mesmo código.

Funciona. Repositórios públicos renderizam em qualquer navegador de celular, README incluído. O app não muda nada quanto ao escaneamento resolver ou não.

Pelo código não, e as estatísticas de tráfego do GitHub só cobrem repositórios seus. Codificar um redirecionamento no seu próprio domínio é a única forma confiável de contar escaneamentos de um pôster ou tiragem específica.

Por que a KoloQR?

  • Crie QR codes para sites, cardápios, Wi-Fi, PDFs e cartões de visita
  • Personalize cores, logos e formas únicas
  • Baixe arquivos PNG e SVG de alta qualidade
  • Feito tanto para impressão quanto para o digital
Gerar QR code
Um QR code preto simples ao lado do mesmo código redesenhado como um círculo com as cores da marca