Pelas nossas próprias experiências, sabemos que o processo de criar um pull request é a maior barreira para novos contribuidores. Nós queríamos agilizar esse processo criando issues muito simples e amigáveis ao contribuidor, para ajudar mais pessoas a se tornarem contribuidoras Open Source pela primeira vez.
Na Hoodie, nosso objetivo é nos tornarmos a comunidade Open Source mais acolhedora possível. Unimos forças com iniciativas como a First Timers Only e Your First PR para buscar ativamente novos contribuidores e criar um ambiente no qual eles se sintam encorajados e apoiados.
Criar o que chamamos de issues iniciais (starter issues) é uma possibilidade. E é uma das mais bem sucedidas. Parte dessas issues iniciais são correções simples como erros de digitação, o que é perfeito para integrar pessoas e ajudá-las a se familiarizar com o GitHub e o processo de pull request. Como erros de digitação e issues similares são tão triviais, basicamente poderíamos gerar automaticamente toda a issue inicial com base em um diff.
Digamos que eu seja um contribuidor da Hoodie e encontrei um erro de digitação em algum lugar. Ao invés de corrigir a issue diretamente na branch main ou perder tempo criando um pull request, eu posso simplesmente criar uma nova branch e chamá-la de algo como first-timers-only-erro-digitacao-no-titulo. O GitHub irá notificar o First Timers Bot sobre a nova branch usando Webhooks. O bot fica de olho em qualquer nova branch que comece com first-timers- e criará uma nova issue no seu repositório. O campo commit pode ser usado para contextualizar e adicionar informações e se deixado vazio, a seção 🤔 What you will need to know simplesmente exibirá "Nothing :)".
First-timers-bot é construído com Probot.
Passos | Exemplo |
---|---|
1) Instalar App em um repositório à sua escolha | |
2) Clique no arquivo que você quer editar. | |
3) Faça a alteração e escreva a sua mensagem de commit em Commit changes. Certifique-se de marcar Create a new branch no final da página e que a branch começa com "first-timers-". | |
4) Clique na aba issues e perceba que sua issue foi criada com sua alteração e a mensagem de commit. O contribuidor então seguirá os passos na mensagem da issue. |
Issue de Exemplo Aqui (em Inglês)
O app first-timers funciona sem nenhuma configuração. Se você quiser mudar as definições padrões, crie um arquivo .github/first-timers.yml com o conteúdo abaixo e ajuste as opções conforme preferir. Quando tanto o template quanto o repositório estiverem definidos, o template será carregado a partir do repositório configured no caminho de template configurado.
# Você pode mudar os labels para se adequarem às suas necessidades se "first-timers-only" não for o que você deseja.
# Esses são alguns exemplos.
labels:
- first-timers-only
# Se quiser adicionar o seu próprio template a essa issue, crie um arquivo .md na sua pasta .github
template: .github/first-timers-issue-template.md
# Você pode criar uma issue em um repositório diferente do qual o problema está. Apenas certifique-se de que você instalou o bot no repositório configurado.
# A issue irá referenciar o repositório original em que a contribuição será feita.
repository: repo-name
Exemplo de Configuração 🖥 💯
Nosso arquivo .github/first-timers.yml
do repositório first-timers/app
está usando o arquivo .github/FIRST_TIMERS_ISSUE_TEMPLATE.md
do repositório hoodiehq/camp
como template para criar uma issue como essa: hoodiehq/camp#126.
Verifique se o distintivo de status no topo deste arquivo está marcado como up
.
Angie Gonzalez |
Arlene Perez |
---|
Angie e Arlene são naturais de Los Angeles e se conheceram ao frequentar o Dev BootCamp em San Francisco. Quando o bootcamp terminou e voltaram a LA, elas ficaram com vontade de fazer parte mais uma vez de uma comunidade incrível e acolhedora como aquela do Dev BootCamp em San Francisco. Por isso fundaram Hoodie através do Rails Girls Summer of Code! Esse projeto é ainda mais especial para elas por ter sido a primeira contribuição open source de ambas.
Obrigado a todos aqueles que contribuíram com esse projeto.
Michael McCombie 🎨 |
Gregor Martynus 👨🏻🏫 |
---|
Esse projeto segue a especificação all-contributors.