Contribuire al progetto World Locking Tools for Unity

Il modo più prezioso per contribuire al progetto World Locking Tools in questo momento è presentare problemi. Qualsiasi feedback su come allineare meglio il progetto World Locking Tools for Unity alle esigenze del progetto è estremamente utile.

Anche se i commenti e i suggerimenti inviati sono utili, ecco alcuni suggerimenti su come rendere i tuoi più interattivi.

Usare le etichette in modo appropriato

Sia quando si invia inizialmente un problema e quando si segue un problema come collaboratore, l'uso appropriato delle etichette è estremamente utile per coordinare con altri collaboratori.

Provare a distinguere in modo accurato ciò che è un bug, qual è una richiesta di funzionalità e qual è un suggerimento più ampio in futuro. Tutti sono preziosi, ma sono più preziosi una volta identificati come tali.

Analogamente, se un problema sembra non eseguibile nel formato corrente, l'applicazione dell'etichetta appropriata (ad esempio, "poco chiaro") può contribuire a migliorare la posizione in cui è utilizzabile. Commenti specifici nel problema stesso sono, naturalmente, estremamente preziosi. Ma l'etichetta corretta può portare altri utenti a visualizzare un commento che potrebbe altrimenti andare inosservato.

Segnalazione di un bug

I problemi possono essere inviati dal portale dei problemi in GitHub. Prendere il tempo per segnalare un problema o fare un suggerimento che altri trarranno vantaggio anche da è sempre apprezzato.

Ogni report di bug ha un proprio contesto, ma in generale, più delle seguenti sono incluse più rapidamente un problema può essere risolto.

File di log dal dispositivo

I file di log dal dispositivo possono essere estremamente utili per analizzare i problemi, soprattutto in combinazione con le acquisizioni di schermate suggerite di seguito. Possono essere ottenuti usando Il portale di dispositivi di Windows durante la connessione al dispositivo, in Cartelle utente di Esplora file > di sistema > \ LocalAppData \ WorldLockingTools

File di log dell'app Unity

UnityPlayer.log si trova nella sottocartella TempState . Si tratta di un file di testo normale.

Registrazione diagnostica degli strumenti di blocco globale

Il file di diagnostica si trova nella sottocartella LocalState . Il nome del file viene generato automaticamente in base al modello seguente:

FrozenWorld-<device name>-<capture date and time>.hkfw

Si tratta di un file binario che necessita di software specializzato da esaminare.

Si noti che per acquisire una registrazione diagnostica è necessario abilitare la registrazione diagnostica nel componente Gestione strumenti di blocco globale nella scena. Per informazioni dettagliate, vedere la documentazione di diagnostica .

Passaggi ripetizione bug

Specificare il modo in cui si verifica il problema. L'ideale è avere un bug che si verifica 100% del tempo dopo un determinato set di passaggi. Ma anche per un bug riscontrato una sola volta, il più dettagliato è possibile correlare i passaggi che portano al problema, meglio.

La procedura di riproduzione deve seguire il formato generale seguente:

  1. A partire da questo normale stato stabile...
  2. Poi ho fatto questo (o notato questa cosa insolita)...
  3. Quindi il sistema ha iniziato a mostrare questo comportamento errato...

Screenshot

Le acquisizioni di schermate consentono di identificare il contesto completo in cui si è verificato il problema. In particolare, la visualizzazione della diagnostica degli strumenti di blocco globale sullo schermo consente di correlare l'esperienza alle informazioni nei log. Le acquisizioni di schermate possono essere immagini snapshot o acquisizioni di video.

Informazioni dispositivo

  • Che tipo di dispositivo?
  • Esecuzione di quale versione del sistema operativo?

Ambiente di compilazione

  • Versione di Unity
  • Versione di Visual Studio

Proposta di una funzionalità

Quando si scopre che World Locking Tools fa quasi quello che serve, le probabilità sono che qualcun altro stia soffrendo la stessa limitazione. Siamo interessati a correggere le lacune nella documentazione e negli esempi, come nel fornire nuove funzionalità.

Nella proposta di una nuova funzionalità, è più utile chiarire cosa si sta cercando di fare. Anche se le idee su come implementarla possono essere utili, le proposte che rendono chiaro il valore aggiunto hanno maggiori probabilità di ottenere trazione. Rendere il problema che la funzionalità risolve ovvio, preferibilmente con ciò che è possibile eseguire con esso in uno scenario reale.

Assicurarsi di associare l'etichetta "miglioramento" al problema della proposta inviata.

Contributi al codice

Si tratta di un progetto open source, quindi naturalmente chiunque può creare un fork per sviluppare in qualsiasi momento. Se qualcuno è abbastanza generoso da condividere il lavoro indietro, allora è molto apprezzato, se viene ripiegato nel repository principale o meno.

Durante questo periodo di implementazione iniziale, saranno disponibili risorse limitate per esaminare e accettare richieste pull nel repository principale. È consigliabile evitare di investire molto tempo in un fork presupponendo che verrà eseguito il merge nel repository principale.

Un modo per attenuare il rischio consiste nell'inviare un problema che propone ciò che è previsto (con etichetta "miglioramento") prima di investire molto tempo in un'implementazione. Si tratta anche di considerare altri collaboratori che potrebbero esaminare la stessa area di problema.

Vedi anche

Processo di rilasciodelle convenzioni di codifica