Ao formatar um problema do GitHub para o MVVMcross, as seguintes práticas recomendadas podem aumentar a clareza, eficiência e colaboração. Aqui estão algumas diretrizes detalhadas:
1. Títulos descritivos **
Use o humor imperativo e verifique se o título é descritivo o suficiente para transmitir o objetivo da questão. Evite encerrar os títulos com períodos. Por exemplo, "Corrija o bug na ligação de dados" é mais eficaz que "bug na ligação de dados" ou "bug de ligação de dados" [4] [7].2. Visão geral limpa **
Forneça uma visão geral concisa do problema em duas linhas ou menos. Isso deve incluir o objetivo principal ou o problema que está sendo abordado. Por exemplo, "esse problema tem como objetivo resolver um erro de ligação de dados causando falhas no aplicativo em dispositivos Android". [1] [4].3. Dependência (se aplicável) **
Se o problema depende de outro problema ser resolvido primeiro, link para esse problema. Isso ajuda a manter um fluxo de trabalho claro e garante que as tarefas dependentes sejam abordadas na ordem correta. Por exemplo, "esse problema depende do [link para a questão dependente]." [1].4. Itens de ação **
Formatar itens de ação como listas de verificação clicáveis. Isso facilita o rastreamento do progresso e atribui tarefas aos membros da equipe. Por exemplo:- [] Pesquise a causa do erro de ligação de dados.
- [] Implementar uma correção para o problema identificado.
- [] Teste a correção em várias plataformas. [1] [4].
5. Recursos/Instruções **
Inclua links para documentação ou recursos relevantes que podem ajudar na resolução do problema. Isso pode incluir tutoriais, documentação da API ou discussões anteriores relacionadas ao problema. Por exemplo, "Consulte [MVVMCROSS Documentation] (https://mvvmcross.com/docs) para obter orientações sobre ligação de dados." [1] [2].6. Cessionários **
Atribua o problema a um membro específico da equipe. Isso garante responsabilidade e clareza sobre quem é responsável pela tarefa. Use o recurso "Cessionários" no GitHub para atribuir usuários. [1].7. Rótulos **
Aplique rótulos relevantes para categorizar o problema. Isso ajuda a filtrar e priorizar os problemas do projeto. Por exemplo, os rótulos podem incluir "recurso de bug", "" ou "aprimoramento". [1] [2].8. Placa de projeto **
Verifique se o problema é adicionado à placa do projeto e corretamente triado. Isso envolve definir o status de problema como "caixa de gelo" se não estiver pronto, "backlog priorizado" se estiver pronto, mas não atribuído e "em andamento", uma vez atribuído. [1].9. Marcos **
Use marcos para rastrear o progresso de grupos de questões ou puxar solicitações. Isso é particularmente útil para projetos maiores ou ao rastrear várias tarefas relacionadas. [1].10. Atualizações de documentação e progresso **
Atualize regularmente os comentários do problema com progresso ou alterações. Isso mantém todas as partes interessadas informadas e facilita a solução colaborativa de problemas. [7].Exemplo de uma questão bem formatada
** Título: Corrija o erro de ligação de dados em dispositivos Android
** Visão geral: Este problema aborda um erro de ligação de dados causando travamentos de aplicativos em dispositivos Android.
** Dependência: depende do [link para a questão dependente].
Itens de ação:
- [] Investigue a causa do erro de ligação de dados.
- [] Implementar uma correção com base nas descobertas.
- [] Realize testes completos entre as plataformas.
** RECURSOS/INSTRUÇÕES: Consulte [MVVMCROSS Documentation] (https://mvvmcross.com/docs) para obter orientação de ligação de dados.
** Cessionários: @UserName
** Rótulos: Bug, Android
Seguindo essas diretrizes, você pode criar problemas bem estruturados do GitHub que aprimoram a colaboração e a eficiência no projeto MVVMCROSS.
Citações:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/devell/contributing.md