Como parte da avaliação final, todos os colaboradores participantes precisam fornecer um link para o trabalho que fizeram no programa. Se isso não for feito corretamente, poderá ocorrer a falha do programa. Há várias maneiras de fazer isso, então leia este documento com atenção.
Esses links vão ser publicados no arquivo público de projetos GSoC. Eles ajudam a demonstrar o trabalho que foi feito durante o programa. Eles também são uma ótima maneira de consultar seu trabalho para futuros empregadores. Você quer que as pessoas entendam rapidamente quais foram as metas do projeto, o que você realizou, onde está seu código e as próximas etapas em potencial.
Os melhores exemplos que vimos nos últimos anos parecem um "relatório final" que contém:
- Uma breve descrição das metas do projeto.
- O que você fez.
- O estado atual.
- O que resta a fazer.
- Qual código foi mesclado (ou não) upstream.
- Quaisquer desafios ou coisas importantes que você aprendeu durante o projeto.
Para conferir exemplos, comece pela Lista de projetos de 2022, escolha projetos aleatoriamente e clique em "VER CÓDIGO". Observe que muitos desses projetos não seguiram nossas sugestões, o que significa que só os prejudica em poder mostrar seu trabalho.
OBSERVAÇÃO PARA COLABORADORES: após enviar seu trabalho final, é possível editá-lo até o prazo final de envio.
Compartilhe o link com o mentor ANTES de enviar a avaliação para garantir que ela atenda às expectativas dele.
Requisitos
- Deve ser fácil identificar o trabalho que você fez. Por exemplo, as mudanças feitas
ou um novo código.
- Quando alguém acessa o URL fornecido, precisa ficar claro o trabalho que você realizou, sem exigir que ele faça uma investigação adicional significativa.
- Ele precisa estar em um local estável. Não é possível alterar o URL após o envio.
- Outra pessoa pode usar o conteúdo no destino do link ou fazer referência a ele para estender seu trabalho.
- Se o seu trabalho estiver 100% concluído, ele deve conseguir usá-lo.
- Se o seu trabalho não estiver 100% concluído, deve ficar claro o que falta fazer.
Bons exemplos
Você não precisa fazer todas (ou nenhuma) essas ações, mas essas são algumas maneiras de atender aos requisitos.
- Crie uma postagem de blog, uma página da Web ou uma gist pública do GitHub que descreva o trabalho
que você fez e links para as confirmações feitas e os repositórios em
que trabalhou. Se ainda houver trabalho a ser feito no projeto, inclua-o também. Você também pode compartilhar destaques ou peças desafiadoras.
- ❗ Essa é a melhor opção, porque permite incluir facilmente muitas informações. Isso é bom porque vai mostrar claramente o trabalho que você fez, além de facilitar o uso e a compreensão do seu código para outras pessoas.
- Se você estiver usando o GitHub e todo o seu trabalho for coberto por uma única solicitação de envio,
use esse link.
- Verifique se a descrição da solicitação de envio está detalhada. Veja as sugestões para conteúdo de postagem do blog acima.
- Verifique se a descrição indica claramente que isso é para o Google Summer of Code.
- Se a solicitação de envio tiver mais trabalho depois do término da GSoC, verifique se a última confirmação de GSoC está anotada.
- ❗ Esse exemplo tem a vantagem de ter o registro de alterações, uma lista de confirmações e os comentários de avaliações em um só lugar.
- Se o repositório do GitHub tiver uma única finalidade para GSoC, adicione um README.md com mais detalhes.
- Envie um e-mail para a lista de e-mails do desenvolvedor arquivada publicamente, com as informações acima, e inclua um link para ela também.
- Crie uma pasta pública no Google Drive e inclua todos os patches que você criou.
- Crie uma planilha pública com o Planilhas Google e liste todas as confirmações.
- Link para um único bug que contenha claramente referências ao trabalho e a qualquer outro item adequado. Ele deve acompanhar todo o trabalho que você fez. Verifique se ele lista todas as confirmações ou se elas são fáceis de encontrar.
- Vincule a uma diferença unificada ou de contexto das suas alterações. Certifique-se de incluir um cabeçalho que indique para qual projeto ele se destina e quem você é, para que seja útil para outras pessoas.
Maus exemplos
Não faça isso.
- Link para um tarball/zipfile que contenha o código-fonte do projeto inteiro ou seu diretório de trabalho. Muitas pessoas já fizeram isso, o que não é útil para pessoas que querem entender mais sobre o que você fez.
- Link para a parte superior do repositório de origem principal do projeto.
- Ou seja, se você estiver trabalhando em cpython, este link não será útil: https://github.com/python/cpython
- Link para seu clone do repositório de origem do projeto.
- Isso dificulta a visualização das mudanças porque seu trabalho está misturado com outros.
- Link para a página do projeto do GSoC.
- Já sabemos o que é isso (ou seja,
https://summerofcode.withgoogle.com/projects/#1234567890
).
- Já sabemos o que é isso (ou seja,
Mentores
Ajude o colaborador a enviar o código corretamente. É importante fazer isso antes do período final de envio do trabalho.
Verifique se...
- A inscrição atende aos requisitos acima.
- O código é compilado.
- Há uma documentação sobre o quê e por quê.
A ideia do GSoC não é que os colaboradores produzam código. É importante que o código seja potencialmente útil para o projeto de código aberto host.