Contribuire alla documentazione MVVMCRoss è un modo prezioso per aiutare a migliorare il quadro e aiutare altri sviluppatori. Ecco una guida passo-passo su come contribuire:
1. Comprendi la struttura della documentazione **
MVVMCROSS utilizza Jekyll per la sua documentazione, il che significa che ogni pagina richiede una questione anteriore YAML. Ciò include la specifica del layout, del titolo e della categoria per la pagina. Il layout è in genere impostato sulla "documentazione" a meno che tu non stia modificando un post sul blog. Le categorie dovrebbero essere riutilizzate e denominate in modo coerente con quelle esistenti nel menu [2].2. Familiarizzare con markdown **
La documentazione utilizza la stessa sintassi di Markdown di GitHub. Puoi fare riferimento al riferimento di markdown di GitHub per le linee guida di formattazione. Ciò include come aggiungere collegamenti e immagini relative alle pagine di documentazione [2].3. Impostazione di Jekyll localmente **
Per cambiamenti maggiori, è utile impostare localmente il sito MVVMCRoss GitHub con Jekyll. Ciò consente di visualizzare in anteprima le modifiche prima di inviarle. Dovrai installare Jekyll e seguire le istruzioni di GitHub per la configurazione a livello locale di un sito di GitHub Pages [2].4. Linee guida per il contributo **
- Titoli e frasi: mantienili brevi e concisi. I titoli dovrebbero idealmente essere lunghi tre o quattro parole.- Ordine cronologico: descrivi gli argomenti in una sequenza logica.
- Rimani sull'argomento: evitare di allontanarti dall'argomento principale.
- Grammatica e punteggiatura: assicurarsi un uso corretto della grammatica e della punteggiatura.
- Controllo ortografico: utilizzare un controllo ortografico per ridurre al minimo gli errori [2].
5. Invia i tuoi contributi **
I contributi vengono in genere effettuati tramite richieste di pull GitHub. È possibile modificare le pagine esistenti o crearne di nuove. Se non sei sicuro di come procedere, puoi iniziare suggerendo modifiche o discuterne con il team tramite problemi di GitHub o altri canali di supporto [1] [5].6. Coinvolgi con la comunità **
Oltre a contribuire alla documentazione, puoi anche aiutare condividendo le tue esperienze con MVVMCRoss, presentando bug o partecipando a discussioni. Questo feedback è prezioso per migliorare il framework [1].7. Processo di revisione **
I tuoi contributi saranno rivisti per assicurarsi che si allineino con lo stile di documentazione e gli standard di qualità. Questo processo aiuta a mantenere la coerenza attraverso la documentazione [2].Seguendo questi passaggi, è possibile contribuire efficacemente alla documentazione MVVMCRoss e aiutare a migliorare la comprensione e l'uso della comunità del framework.
Citazioni:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross