Merge branch 'master' of https://github.com/devcode-it/openstamanager
This commit is contained in:
Bacca97
commit
0d18ced469
|
|
@ -0,0 +1,67 @@
|
||||||
|
# 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
|
||||||
|
|
||||||
|
Per migliorare il sistema con cui sviluppiamo il codice, abbiamo deciso di adottare alcune linee guida per facilitare la collaborazione tra più persone.
|
||||||
|
|
||||||
|
### Codice di condotta
|
||||||
|
|
||||||
|
Per il momento non abbiamo adottato un vero e proprio codice di condotta, ma ti chiediamo di essere il più civile possibile nel comunicare con gli altri per questo progetto.
|
||||||
|
|
||||||
|
### Stile del codice
|
||||||
|
|
||||||
|
Utilizziamo principalmente due strumenti per mantenere consistente nel tempo lo stile del codice:
|
||||||
|
- [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).
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
Se trovi un problema di sicurezza, NON aprire una issue. Inviaci un'email all'indirizzo `info at openstamanager dot com`.
|
||||||
|
|
||||||
|
Per capire se hai individuato un problema di sicurezza, prova a farti queste domande:
|
||||||
|
|
||||||
|
* 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.
|
||||||
|
|
||||||
|
## Segnalare un bug
|
||||||
|
|
||||||
|
Se hai individuato un bug e desideri segnalarlo, apri una nuova issue provando a mantenerti sulla base del [file di template su GitHub](https://github.com/devcode-it/openstamanager/blob/master/.github/ISSUE_TEMPLATE.md).
|
||||||
|
|
||||||
|
Se vuoi suggerire una miglioramento di qualche tipo oppure una nuova funzionalità, sentiti libero di aprire una issue apposita dove spieghi dettagliatamente la modifica che vorresti, la sua utilità e il suo funzionamento generale
|
||||||
|
|
||||||
|
## Pull Request
|
||||||
|
|
||||||
|
Se sei in grado di risolvere uno dei bug segnalati oppure vuoi completare una nuova funzionalità, apri una nuova Pull Request provando a mantenerti sulla base del [file di template su GitHub](https://github.com/devcode-it/openstamanager/blob/master/.github/PULL_REQUEST_TEMPLATE.md).
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Siamo presenti su [Facebook](https://www.facebook.com/openstamanager), e il nostro forum ufficiale è disponibile all'indirizzo <http://www.openstamanager.com/forum/>.
|
||||||
|
|
||||||
|
Cerchiamo di essere disponibili quanto possibile, ma non sempre riusciamo a rispondere tempestivamente.
|
||||||
|
|
@ -0,0 +1,38 @@
|
||||||
|
## Comportamento richiesto
|
||||||
|
|
||||||
|
Descrivi il comportamento che ti aspetti dal progetto.
|
||||||
|
|
||||||
|
## Comportamento attuale
|
||||||
|
|
||||||
|
Qual è il comportamento attuale, e come ti aspetti che venga migliorato?
|
||||||
|
|
||||||
|
## Possibile soluzione
|
||||||
|
|
||||||
|
[Non obbligatorio] Hai suggerimenti su come risolvere il bug o individuarne le cause?
|
||||||
|
|
||||||
|
## Passi per riprodurre il comportamento
|
||||||
|
|
||||||
|
[Per i bug] Descrivi dettagliatamente i singoli passi per riprodurre il malfunzionamento.
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
Eventuale codice rilevante:
|
||||||
|
```php
|
||||||
|
Se serve, aggiungi qui il codice che vuoi farci testare
|
||||||
|
```
|
||||||
|
|
||||||
|
Eventuali log relativi (cartella **logs/**):
|
||||||
|
```
|
||||||
|
Se presenti, aggiungi qui i log relativi al malfunzionamento
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contesto
|
||||||
|
|
||||||
|
Inserisci le informazioni riguardanti il tuo ambiente di esecuzione. Può essere utile per individuare problemi riproducibili solo con condizioni specifiche.
|
||||||
|
|
||||||
|
* Modulo:
|
||||||
|
* Versione del progetto:
|
||||||
|
* Versione PHP:
|
||||||
|
* Tipo di server:
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
## Descrizione
|
||||||
|
|
||||||
|
Includi un sommario dei cambiamenti introdotti, con il relativo contesto.
|
||||||
|
Elenca anche le eventuali dipendenze aggiuntive richieste per questa modifica.
|
||||||
|
|
||||||
|
Risolve: #(issue)
|
||||||
|
|
||||||
|
## Tipologia
|
||||||
|
|
||||||
|
Rimuovi le opzioni non rilevanti.
|
||||||
|
|
||||||
|
- [ ] Bug fix (cambiamenti minori che risolvono una issue)
|
||||||
|
- [ ] Nuova funzionalità (cambiamenti minori che aggiungono una nuova funzionalità)
|
||||||
|
- [ ] Cambiamento maggiore (fix o funzionalità che richiede una revisione prima di essere pubblicata)
|
||||||
|
- [ ] Questo cambiamenti richiede un aggiornamento della documentazione
|
||||||
|
|
||||||
|
# Checklist
|
||||||
|
|
||||||
|
- [ ] Il codice segue le linee guida del progetto
|
||||||
|
- [ ] Ho commentato il codice, in particolare nelle parti più complesse
|
||||||
|
- [ ] Ho aggiornato di conseguenza la documentazione (se presente)
|
||||||
|
- [ ] Il codice non genera warnings
|
||||||
|
|
@ -4,7 +4,81 @@ currentMenu: contribuire
|
||||||
|
|
||||||
# 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.
|
||||||
|
|
||||||
<!-- TOC depthFrom:2 depthTo:6 orderedList:false updateOnSave:true withLinks:true -->
|
<!-- TOC depthFrom:2 depthTo:6 orderedList:false updateOnSave:true withLinks:true -->
|
||||||
|
|
||||||
|
- [Linee guida](#linee-guida)
|
||||||
|
- [Codice di condotta](#codice-di-condotta)
|
||||||
|
- [Stile del codice](#stile-del-codice)
|
||||||
|
- [Prima contribuzione](#prima-contribuzione)
|
||||||
|
- [Problemi di sicurezza](#problemi-di-sicurezza)
|
||||||
|
- [Segnalare un bug](#segnalare-un-bug)
|
||||||
|
- [Pull Request](#pull-request)
|
||||||
|
- [Community](#community)
|
||||||
|
|
||||||
<!-- /TOC -->
|
<!-- /TOC -->
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
### Codice di condotta
|
||||||
|
|
||||||
|
Per il momento non abbiamo adottato un vero e proprio codice di condotta, ma ti chiediamo di essere il più civile possibile nel comunicare con gli altri per questo progetto.
|
||||||
|
|
||||||
|
### Stile del codice
|
||||||
|
|
||||||
|
Utilizziamo principalmente due strumenti per mantenere consistente nel tempo lo stile del codice:
|
||||||
|
- [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).
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
Se trovi un problema di sicurezza, NON aprire una issue. Inviaci un'email all'indirizzo `info at openstamanager dot com`.
|
||||||
|
|
||||||
|
Per capire se hai individuato un problema di sicurezza, prova a farti queste domande:
|
||||||
|
|
||||||
|
* 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.
|
||||||
|
|
||||||
|
## Segnalare un bug
|
||||||
|
|
||||||
|
Se hai individuato un bug e desideri segnalarlo, apri una nuova issue provando a mantenerti sulla base del [file di template su GitHub](https://github.com/devcode-it/openstamanager/blob/master/.github/ISSUE_TEMPLATE.md).
|
||||||
|
|
||||||
|
Se vuoi suggerire una miglioramento di qualche tipo oppure una nuova funzionalità, sentiti libero di aprire una issue apposita dove spieghi dettagliatamente la modifica che vorresti, la sua utilità e il suo funzionamento generale
|
||||||
|
|
||||||
|
## Pull Request
|
||||||
|
|
||||||
|
Se sei in grado di risolvere uno dei bug segnalati oppure vuoi completare una nuova funzionalità, apri una nuova Pull Request provando a mantenerti sulla base del [file di template su GitHub](https://github.com/devcode-it/openstamanager/blob/master/.github/PULL_REQUEST_TEMPLATE.md).
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Siamo presenti su [Facebook](https://www.facebook.com/openstamanager), e il nostro forum ufficiale è disponibile all'indirizzo <http://www.openstamanager.com/forum/>.
|
||||||
|
|
||||||
|
Cerchiamo di essere disponibili quanto possibile, ma non sempre riusciamo a rispondere tempestivamente.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue