Lidar com problemas incompletos do GitHub em seu projeto de código aberto

Se você mantiver um projeto de código aberto, provavelmente já viu esse cenário: alguém abre um problema do GitHub quase sem detalhes. Você tem algo como: “Não funciona!” Não há etapas para reproduzir, sem informações do ambiente, nem mesmo a versão que eles estão usando. Frustrante, certo? Para os mantenedores, esses problemas vagos podem se tornar um enorme tempo afundando. Você passa mais tempo perseguindo detalhes do que realmente resolvendo o problema. Por que isso acontece muitos colaboradores são novos no GitHub ou em código aberto. Eles sabem que há um problema, mas não sabem que informação é importante. Como mantenedor de projetos, cabe a você facilitar a comunicação claramente. Sua solução: modelos de problemas do github Se você tiver um projeto de código aberto, os modelos de emissão são seu melhor amigo. Eles orientam os colaboradores para fornecer os detalhes certos antecipadamente. Por exemplo, um modelo de relatório de bugs pode solicitar: etapas para reproduzir detalhes de ambiente de comportamento esperados versus reais (SO, navegador, versões) Um modelo de solicitação de recurso pode solicitar: motivação para os casos de uso de recursos possíveis idéias de implementação, fornecendo uma estrutura clara, você reduz e reduz os problemas que são acionáveis desde o primeiro dia. A aparência de quando um colaborador cria uma nova questão minha experiência como mantenedora depois de adicionar modelos de problemas aos meus projetos, notei uma grande melhoria: os colaboradores forneceram informações detalhadas dos problemas de depuração e corrigir de início, tornaram -se mais rápidos que a colaboração geral melhorou até mesmo um pequeno projeto se beneficia de modelos: eles economizam tempo, reduzem a frustração e mantenham a sua comunidade feliz. Takeaway Se você mantiver um projeto de código aberto, não espere os colaboradores “descobrirem”. Configure modelos de emissão do GitHub. É uma maneira simples de melhorar a comunicação, simplificar seu fluxo de trabalho e ajudar seu projeto a prosperar. O código aberto funciona melhor quando todos sabem como colaborar de maneira eficaz e os modelos de emissão facilitam isso. Bônus: como adicionar um modelo de problema no github vá ao seu repositório no Github. Clique em Configurações → Problemas → Configurar modelos. Escolha relatório de bug, solicitação de recurso ou modelo personalizado. Preencha as seções para orientar os colaboradores. Salve e cometesse o modelo. Agora, todo novo problema solicitará ao colaborador preencher os detalhes relevantes.

Fonte

Publicar comentário

Você pode ter perdido