Como enviar seu repositório para o GitHub Community Exchange

Você pode enviar seu repositório para GitHub Community Exchange para que outras pessoas vejam ou colaborem.

Neste artigo

Sobre envios de repositório

Somente repositórios públicos pertencentes a contas pessoais podem ser enviados para GitHub Community Exchange.

Há três tipos de envios de repositório:

  • Aprender. Um repositório para compartilhar instruções passo a passo para criar um projeto.
  • Colaborar. Um repositório que busca colaboradores para trabalhar em um projeto.
  • Aprender e colaborar. Um repositório que é uma combinação de Learn e Collaborate.

Considere qual é a principal finalidade do repositório ao escolher o tipo de envio do seu repositório.

Para promover seu projeto e torná-lo mais detectável para outros alunos, você deve atribuir um ou mais tópicos e ofertas do GitHub Student Developer Pack ao seu repositório. Para saber mais, confira Classificar repositório com tópicos.

Depois que um repositório tiver sido enviado para GitHub Community Exchange, ele será publicado imediatamente com a finalidade, os tópicos e as ofertas escolhidos. A comunidade GitHub Community Exchange modera todos os envios de repositório.

Requisitos de envio

Seu repositório precisa atender a um conjunto mínimo de requisitos para que um envio seja aceito. Durante o processo de envio, se os critérios de envio não tiverem sido atendidos para o repositório selecionado, você será notificado sobre os itens ausentes.

Para um envio com uma finalidade de Learn, seu repositório precisa ter:

  • Uma descrição.
  • Um arquivo LEARN.md para fornecer instruções passo a passo, com texto e/ou mídia, sobre como você criou seu projeto. Idealmente, seu arquivo LEARN.md desconstruirá seu projeto em pequenos componentes e fornecerá detalhes completos de cada etapa, para que outros alunos possam codificar o próprio projeto seguindo suas instruções.
  • Um arquivo README.md para fornecer uma descrição detalhada do seu projeto.
  • Uma Licença para que outras pessoas estejam cientes do que podem ou não fazer com o seu código-fonte.

Para um envio com uma finalidade de Collaborate, seu repositório precisa ter:

  • Uma descrição.
  • Um arquivo README.md para fornecer uma descrição detalhada do seu projeto.
  • Uma Licença para que outras pessoas estejam cientes do que podem ou não fazer com o seu código-fonte.
  • Um ou mais problemas nos quais os colaboradores trabalham.
  • O arquivo CONTRIBUTING.md para comunicar como contribuir para o projeto.

Um bom envio de repositório para finalidades de Learn e Collaborate é um repositório que segue os padrões da comunidade. Para saber mais, confira Sobre perfis de comunidade para repositórios públicos.

Como enviar seu repositório

  1. No seu painel GitHub Education, navegue até a página inicial do GitHub Community Exchange.
  2. Em cima da lista de repositórios, à direita dos filtros de pesquisa e lista suspensa, clique em Adicionar repositório.
    Captura de tela de uma linha de botões e menus suspensos. O botão "Adicionar repositório" está realçado em laranja escuro.
  3. Na janela pop-up, use o menu suspenso Qual é a finalidade do seu envio? e selecione uma ou mais entradas correspondentes ao envio.
  4. Use o menu suspenso Qual repositório você gostaria de usar? e selecione o repositório para o seu envio. Se os critérios de envio não tiverem sido atendidos, você receberá uma notificação sobre os itens ausentes e poderá clicar em Editar seu repositório se quiser ver o repositório e fazer alterações para atender aos critérios.
  5. Use o menu suspenso Quais ofertas você usou para seu projeto? e selecione uma ou mais entradas correspondentes ao seu envio.
  6. Clique em Enviar o projeto.