From e2b80bb8f7850579ff2949dc9a0c06ab5457d509 Mon Sep 17 00:00:00 2001 From: Thomas Zilio Date: Tue, 6 Feb 2018 16:13:47 +0100 Subject: [PATCH] Miglioramento documentazione --- .github/CONTRIBUTING.md | 16 ++++++++++++---- docs/Contribuire.md | 28 ++++++++++++++++++---------- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2f48641f4..21bdc7f6e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,11 +1,14 @@ # Contribuire Sei interessato a contribuire allo sviluppo di OpenSTAManger? Ottimo, sei il benvenuto! + Siamo entusiasti di ogni nuova contribuzione che otteniamo dalla nostra community. Ci sono molti modi per contribuire: segnalare bug, richiedere miglioramenti, scrivere tutorial, migliorare la documentazione... Non serve essere degli esperti programmatori per aiutarci! :smile_cat: -Leggi le seguenti sezione per scoprire come ti consigliamo di procedere. Se ti serve un aiuto, crea una issue su GitHub. + +Leggi le seguenti sezioni per scoprire come ti consigliamo di procedere. +Se ti serve un aiuto, crea una issue su GitHub. ## Linee guida @@ -21,15 +24,18 @@ Utilizziamo principalmente due strumenti per mantenere consistente nel tempo lo - [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) - [EditorConfig](http://editorconfig.org>) -PHP CS Fixer viene utilizzato per formattare automaticamente il codice PHP e aumentare la sua comprensibilità. La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.php_cs). +PHP CS Fixer viene utilizzato per formattare automaticamente il codice PHP e aumentare la sua comprensibilità. +La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.php_cs). -EditorConfig viene sfruttato per mantenere la consistenza nella formattazione di base dei diversi altri file utilizzati nel progetto. La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.editorconfig). +EditorConfig viene sfruttato per mantenere la consistenza nella formattazione di base dei diversi altri file utilizzati nel progetto. +La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.editorconfig). Maggiori informazioni sui plugin che permettono di integrare questi strumenti sono disponibili nei relativi siti. ## Prima contribuzione Sei insicuro su cosa potresti lavorare per contribuire al progetto? + Prova a dare un'occhiata alle issue sotto la label [nuovi contributori](https://github.com/devcode-it/openstamanager/labels/nuovi%20contributori), dove sono indicate le migliorie più semplici da applicare. ## Problemi di sicurezza @@ -41,7 +47,8 @@ Per capire se hai individuato un problema di sicurezza, prova a farti queste dom * Posso accedere a qualcosa a cui non dovrei avere accesso? * Posso disabilitare qualcosa per altre persone? -Se la risposta a una di queste domande è positiva, allora probabilmente hai individuato un problema di sicurezza. Considera però che anche in caso negativo potrebbe trattarsi di un problema di questo tipo, quindi se sei insicuro contattaci comunque via email. +Se la risposta a una di queste domande è positiva, allora probabilmente hai individuato un problema di sicurezza. +Considera però che anche in caso negativo potrebbe trattarsi di un problema di questo tipo, quindi se sei insicuro contattaci comunque via email. ## Segnalare un bug @@ -56,4 +63,5 @@ Se sei in grado di risolvere uno dei bug segnalati oppure vuoi completare una nu ## Community Siamo presenti su [Facebook](https://www.facebook.com/openstamanager), e il nostro forum ufficiale è disponibile all'indirizzo . + Cerchiamo di essere disponibili quanto possibile, ma non sempre riusciamo a rispondere tempestivamente. diff --git a/docs/Contribuire.md b/docs/Contribuire.md index 140607c64..9a19cb6cc 100644 --- a/docs/Contribuire.md +++ b/docs/Contribuire.md @@ -4,6 +4,16 @@ currentMenu: contribuire # Contribuire +Sei interessato a contribuire allo sviluppo di OpenSTAManger? Ottimo, sei il benvenuto! + +Siamo entusiasti di ogni nuova contribuzione che otteniamo dalla nostra community. +Ci sono molti modi per contribuire: segnalare bug, richiedere miglioramenti, scrivere tutorial, migliorare la documentazione... + +Non serve essere degli esperti programmatori per aiutarci! :smile_cat: + +Leggi le seguenti sezioni per scoprire come ti consigliamo di procedere. +Se ti serve un aiuto, crea una issue su GitHub. + - [Linee guida](#linee-guida) @@ -17,13 +27,6 @@ currentMenu: contribuire -Sei interessato a contribuire allo sviluppo di OpenSTAManger? Ottimo, sei il benvenuto! -Siamo entusiasti di ogni nuova contribuzione che otteniamo dalla nostra community. -Ci sono molti modi per contribuire: segnalare bug, richiedere miglioramenti, scrivere tutorial, migliorare la documentazione... - -Non serve essere degli esperti programmatori per aiutarci! :smile_cat: -Leggi le seguenti sezione per scoprire come ti consigliamo di procedere. Se ti serve un aiuto, crea una issue su GitHub. - ## Linee guida Per migliorare il sistema con cui sviluppiamo il codice, abbiamo deciso di adottare alcune linee guida per facilitare la collaborazione tra più persone. @@ -38,15 +41,18 @@ Utilizziamo principalmente due strumenti per mantenere consistente nel tempo lo - [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) - [EditorConfig](http://editorconfig.org>) -PHP CS Fixer viene utilizzato per formattare automaticamente il codice PHP e aumentare la sua comprensibilità. La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.php_cs). +PHP CS Fixer viene utilizzato per formattare automaticamente il codice PHP e aumentare la sua comprensibilità. +La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.php_cs). -EditorConfig viene sfruttato per mantenere la consistenza nella formattazione di base dei diversi altri file utilizzati nel progetto. La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.editorconfig). +EditorConfig viene sfruttato per mantenere la consistenza nella formattazione di base dei diversi altri file utilizzati nel progetto. +La configurazione può essere trovata nel file [.php_cs](https://github.com/devcode-it/openstamanager/blob/master/.editorconfig). Maggiori informazioni sui plugin che permettono di integrare questi strumenti sono disponibili nei relativi siti. ## Prima contribuzione Sei insicuro su cosa potresti lavorare per contribuire al progetto? + Prova a dare un'occhiata alle issue sotto la label [nuovi contributori](https://github.com/devcode-it/openstamanager/labels/nuovi%20contributori), dove sono indicate le migliorie più semplici da applicare. ## Problemi di sicurezza @@ -58,7 +64,8 @@ Per capire se hai individuato un problema di sicurezza, prova a farti queste dom * Posso accedere a qualcosa a cui non dovrei avere accesso? * Posso disabilitare qualcosa per altre persone? -Se la risposta a una di queste domande è positiva, allora probabilmente hai individuato un problema di sicurezza. Considera però che anche in caso negativo potrebbe trattarsi di un problema di questo tipo, quindi se sei insicuro contattaci comunque via email. +Se la risposta a una di queste domande è positiva, allora probabilmente hai individuato un problema di sicurezza. +Considera però che anche in caso negativo potrebbe trattarsi di un problema di questo tipo, quindi se sei insicuro contattaci comunque via email. ## Segnalare un bug @@ -73,4 +80,5 @@ Se sei in grado di risolvere uno dei bug segnalati oppure vuoi completare una nu ## Community Siamo presenti su [Facebook](https://www.facebook.com/openstamanager), e il nostro forum ufficiale è disponibile all'indirizzo . + Cerchiamo di essere disponibili quanto possibile, ma non sempre riusciamo a rispondere tempestivamente.