Como contribuir melhor com o projeto World Locking Tools para Unity
A maneira mais útil de contribuir com o projeto World Locking Tools neste momento é arquivar problemas. Todo e quaisquer comentários sobre como alinhar melhor o projeto World Locking Tools para Unity com as necessidades do seu projeto são extremamente importantes.
Embora os comentários postados sejam importantes, veja abaixo algumas dicas sobre como tornar o seu mais acionável.
Usar rótulos adequadamente
Ao enviar inicialmente um problema e ao acompanhar um problema como colaborador, o uso adequado de rótulos é extremamente útil na coordenação com outros colaboradores.
Tente diferenciar com precisão entre o que é um bug, o que é uma solicitação de recurso e o que é uma sugestão mais abrangente daqui para frente. Todos são importantes, mas são mais importantes depois de identificados como tal.
Da mesma forma, se um problema parecer não acionável na forma atual, aplicar o rótulo adequado (por exemplo, "confuso") pode ajudar a aprimorá-lo de modo a se tornar acionável. É claro que comentários específicos sobre o problema em si são extremamente importantes. Mas o rótulo adequado pode levar outras pessoas a ver um comentário que, de outra forma, poderia passar despercebido.
Como relatar um bug
Os problemas podem ser enviados pelo portal de problemas no GitHub. Dedicar um tempo para relatar um problema ou fazer uma sugestão que outras pessoas também aproveitarão é sempre bem-vindo.
Cada relatório de bugs tem seu próprio contexto, mas, em geral, quanto mais das seguintes informações forem incluídas, mais rapidamente um problema poderá ser resolvido.
Arquivos de log do dispositivo
Os arquivos de log do dispositivo podem ser muito úteis na investigação de problemas, especialmente em conjunto com as capturas de tela sugeridas abaixo. Eles podem ser obtidos usando o Portal de Dispositivos do Windows, enquanto estiver conectado ao seu dispositivo, em Sistema > Gerenciador de arquivos > Pastas de Usuário \ LocalAppData \ WorldLockingTools
O arquivo de log do aplicativo Unity
UnityPlayer.log está localizado na subpasta TempState. Esse é um arquivo de texto sem formatação.
A gravação de diagnóstico do World Locking Tools
O arquivo de diagnóstico está localizado na subpasta LocalState. O nome do arquivo é gerado automaticamente de acordo com o seguinte padrão:
FrozenWorld-<device name>-<capture date and time>.hkfwÉ um arquivo binário que precisa de software especializado para examinar.
Observe que a captura de uma gravação de diagnóstico requer que a Gravação de Diagnóstico seja habilitada no componente do Gerenciador do World Locking Tools na cena. Confira a documentação de diagnóstico para obter detalhes.
Etapas de reprodução
Especifique como o problema ocorre prontamente. O ideal é ter um bug que ocorra 100% das vezes seguindo determinado conjunto de etapas. Mas mesmo para um bug que você viu acontecer apenas uma vez, quanto mais detalhadamente você puder relacionar as etapas que levaram ao problema, melhor.
As etapas de reprodução devem seguir esta forma geral:
- A partir deste estado normal e estável...
- Em seguida, fiz isso (ou observei essa atividade incomum)...
- Em seguida, o sistema começou a mostrar esse comportamento incorreto...
Capturas de tela
As capturas de tela ajudarão a identificar o contexto completo em que o problema ocorreu. Especificamente, exibir o diagnóstico do World Locking Tools na tela pode ajudar a correlacionar a sua experiência com as informações nos logs. As capturas de tela podem ser imagens de instantâneo ou capturas de vídeo.
Informações do dispositivo
- Qual tipo de dispositivo?
- Qual versão de SO em execução?
Ambiente de build
- Versão do Unity
- Versão do Visual Studio
Como propor um recurso
Quando você descobre que o World Locking Tools quase faz o que você precisa, provavelmente outra pessoa está passando pela mesma limitação. Estamos tão interessados em corrigir lacunas em nossa documentação e em nossos exemplos quanto em fornecer novos recursos.
Ao propor um novo recurso, é mais importante deixar claro o que você está tentando fazer. Embora as ideias sobre como implementá-lo também possam ser úteis, as propostas que deixam claro o valor agregado são mais propensas a ganhar força. Deixe evidente o problema que o recurso resolve, de preferência com o que você poderia realizar com ele em um cenário do mundo real.
Anexe o rótulo "melhoria" ao problema da proposta enviada.
Código de contribuição
Este é um projeto de código aberto, então é claro que qualquer um pode fazer uma bifurcação a ser desenvolvida a qualquer momento. Se alguém for generoso o suficiente para compartilhar de volta o trabalho, será muito valorizado, independentemente de ser dobrado de volta para o repositório principal.
Durante esse período de distribuição inicial, teremos recursos limitados para examinar e aceitar solicitações de pull no repositório principal. É aconselhável evitar investir muito tempo em uma bifurcação com a suposição de que será mesclada de volta ao repositório principal.
Uma maneira de mitigar o risco é enviar um problema propondo sua intenção (com o rótulo "melhoria"), antes de investir muito tempo em uma implementação. Isso também é considerado em relação a outros colaboradores que possam estar olhando para a mesma área do problema.