Contribuire a Rust — documentazione
La documentazione non è mai abbastanza buona e non ce ne mai troppa. Molti aspetti della documentazione di Rust non richiedono una profonda conoscenza per essere migliorati, scritti, corretti o modificati, inoltre modificare la documentazione è un ottimo modo per imparare Rust. Ulteriormente i miglioramenti sono semplici da identificare e potenzialmente infiniti: non ti piace come suona una frase? Hai scoperto qualcosa che nella documentazione non è presente? La tua richiesta di modifica verrà calorosamente accolta.
La documentazione più importante che tu possa scrivere è per i pacchetti che fanno parte dell’ecosistema di Rust.
Mentre la documentazione principale è relativamente esaustiva, ciò non è vero per molti pacchetti e strumenti popolari con cui gli sviluppatori Rust interagiscono ogni giorno. Contribuire alla documentazione delle API per un progetto popolare ti garantirà l’affetto da parte dello sviluppatore del progetto.
Il libro è la documentazione base per Rust,
scritto nel repository principale.
Possiede anche la sua etichetta per le problematiche, A-book ed
è continuamente in miglioramento.
Ulteriore documentazione nel repository principale include il riferimento di Rust,
la documentazione della libreria standard, Il Rustonomico (un guida su come usare unsafe
correttamente). Le guide di stile di Rust sono così incomplete che non vengono elencate spesso;
uno sviluppatore ambizioso può sicuramente fare molta strada contribuendo lì.
L’indice degli errori fornisce spiegazioni dettagliate agli errori del compilatore.
Quando vengono aggiunti nuovi errori, essi devono essere inclusi nella documentazione, quindi ci sono
sempre errori non presenti ancora ma con la necessità di essere aggiunti.
La maggior parte della documentazione nel repository principale risiede nella cartella src/doc.
Tutti i problemi di documentazione sono sotto all’etichetta A-docs sul portale delle problematiche.
Finalmente questo documento e altri correlati con il sito web sono mantenuti nel repository Git del sito.
Per contribuire modificalo e manda una pull request.
Una buona quantità di documentazione importante per Rust non si trova nel repository principale o non è mantenuta dal progetto Rust ma è comunque importantissima per il successo di Rust. Esempi di documentazione eccellente sotto attivo sviluppo con domanda per altri sviluppatori includono Rust By Example, Rust Design Patterns e rust-rosetta. Per altri progetti di documentazione esistenti a cui contribuire vedi rust-learning.
Incontra altri documentatori su #rust-docs.