Contribuindo para o projeto World Locking Tools for Unity
A maneira mais valiosa de contribuir para o projeto World Locking Tools neste momento é arquivando problemas. Todo e qualquer feedback sobre como alinhar melhor o projeto World Locking Tools for Unity com as necessidades do seu projeto é extremamente valioso.
Embora qualquer feedback que você postar seja valioso, aqui estão algumas dicas para tornar o seu mais acionável.
Use os rótulos adequadamente
Tanto ao submeter inicialmente um problema, como ao acompanhar um problema como contribuidor, o uso adequado de rótulos é extremamente útil na coordenação com outros contribuidores.
Tente diferenciar com precisão entre o que é um bug, o que é uma solicitação de recurso e o que é uma sugestão mais ampla daqui para frente. Todos são valiosos, mas são mais valiosos uma vez identificados como tal.
Da mesma forma, se um problema parecer impraticável em sua forma atual, a aplicação do rótulo apropriado (por exemplo, "obscuro") pode ajudar a melhorá-lo para onde é acionável. Os comentários específicos sobre a própria questão são, naturalmente, extremamente valiosos. Mas o rótulo adequado pode levar outras pessoas a ver um comentário que, de outra forma, poderia passar despercebido.
Relatar um bug
Os problemas podem ser enviados a partir do portal de questões no GitHub. Dedicar tempo para relatar um problema ou fazer uma sugestão de que os outros também se beneficiarão é sempre apreciado.
Cada relatório de bug tem seu próprio contexto, mas, em geral, quanto mais itens a seguir forem incluídos, mais rapidamente um problema poderá ser resolvido.
Arquivos de log do dispositivo
Os arquivos de log do dispositivo podem ser imensamente úteis na investigação de problemas, especialmente em conjunto com as capturas de tela sugeridas abaixo. Eles podem ser obtidos usando o Windows Device Portal enquanto conectado ao seu dispositivo, em System > File explorer > User Folders \ LocalAppData \ WorldLockingTools
O arquivo de log do aplicativo Unity
UnityPlayer.log está localizado na subpasta TempState. Este é um ficheiro de texto simples.
Gravação de diagnóstico das World Locking Tools
O arquivo de diagnóstico está localizado na subpasta LocalState . O nome do ficheiro é 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, para capturar uma gravação de diagnóstico, é necessário habilitar a Gravação de diagnóstico no componente Gerenciador de ferramentas de bloqueio mundial em sua cena. Consulte a documentação de diagnóstico para obter detalhes.
Etapas de reprodução
Especifique a facilidade com que o problema acontece. O ideal é ter um bug que ocorra 100% do tempo após um determinado conjunto de passos. Mas mesmo para um bug que você só viu acontecer uma vez, quanto mais detalhado você puder relacionar as etapas que levam ao problema, melhor.
As etapas de reprodução devem seguir a seguinte forma geral:
- A partir deste estado estável normal...
- Então eu fiz isso (ou notei essa coisa incomum)...
- Então o sistema começou a mostrar esse comportamento incorreto...
Capturas de ecrã
As capturas de tela ajudarão a identificar o contexto completo em que o problema ocorreu. Em particular, ter o diagnóstico das Ferramentas de Bloqueio Mundial exibido na tela pode ajudar a correlacionar sua experiência com as informações nos logs. As capturas de tela podem ser imagens instantâneas ou capturas de vídeo.
Informações do dispositivo
- Que tipo de dispositivo?
- Executando qual versão do sistema operacional?
Ambiente de construção
- Versão Unity
- Versão do Visual Studio
Propor uma funcionalidade
Quando você descobre que World Locking Tools quase faz o que você precisa, as chances são de que outra pessoa está sofrendo a mesma limitação. Estamos tão interessados em corrigir lacunas em nossa documentação e exemplos quanto em fornecer novos recursos.
Ao propor um novo recurso, é mais valioso deixar claro o que você está tentando fazer. Embora as ideias sobre a forma de a aplicar também possam ser úteis, é mais provável que as propostas que tornem claro o valor acrescentado ganhem força. Torne o problema que o recurso resolve óbvio, de preferência com o que você poderia realizar com ele em um cenário do mundo real.
Certifique-se de anexar o rótulo "melhoria" à questão da proposta enviada.
Código de contribuição
Este é um projeto de código aberto, então é claro que qualquer pessoa pode fazer um fork para desenvolver a qualquer momento. Se alguém é generoso o suficiente para compartilhar o trabalho de volta, então é muito apreciado, quer seja dobrado de volta para o repositório principal ou não.
Durante esse período inicial de implantação, teremos recursos limitados para revisar e aceitar solicitações pull no repositório principal. É aconselhável evitar investir muito tempo em uma bifurcação sob a suposição de que ela será mesclada de volta ao repositório principal.
Uma maneira de mitigar o risco é enviar uma questão propondo o que se pretende (rotulado como "aprimoramento") antes de investir muito tempo em uma implementação. Isso também é considerado em relação a outros contribuintes que podem estar olhando para a mesma área problemática.