diff --git a/it/CHANGELOG.md b/it/CHANGELOG.md index e69de29..d88f848 100644 --- a/it/CHANGELOG.md +++ b/it/CHANGELOG.md @@ -0,0 +1,49 @@ +# Log delle Modifiche + +Tutte le modifiche notevoli saranno documentate su questo file. + +Questo format è basato su [Keep a Changelog](http://keepachangelog.com/) e questo progetto aderisce a [Semantic Versioning](http://semver.org/). + +## [Non Rilasciato] - yyyy-mm-dd + +Qua scriviamo note per le aziende per aggiornare. È uno sforzo di gruppo renderle il più semplice possibile. + +### Aggiunto + +- [NOMEPROGETTO-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) + MINOR Titolo ticket va qua. +- [NOMEPROGETTO-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) + PATCH Titolo ticket va qua. + +### Cambiato + +### Sistemato + +## [1.2.4] - 2017-03-15 + +Qua avremmo le istruzioni per gli utenti da seguire per aggiornare a 1.2.4. + +### Aggiunto + +### Cambiato + +- [NOMEPROGETTO-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) + PATCH Drupal.org è ora usato come composer. + +### Sistemato + +- [NOMEPROGETTO-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) + PATCH Aggiunta logica a runsheet teaser delete per cancellare corrispondenti schedule cards. + +## [1.2.3] - 2017-03-14 + +### Aggiunto + +### Cambiato + +### Sistemato + +- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) + MINOR Sistemati i test per il modulo foo +- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) + MAJOR La timeline del modulo foo usa il fuso orario del browser per la risoluzione della data diff --git a/it/CODEBASE_STRUCTURE.md b/it/CODEBASE_STRUCTURE.md index e69de29..f658637 100644 --- a/it/CODEBASE_STRUCTURE.md +++ b/it/CODEBASE_STRUCTURE.md @@ -0,0 +1,41 @@ +Queste sono le cartelle che stiamo usando attivamente nello sviluppo: + +- [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): I controller che si occupano della logica ed espongono l'API del server. +- [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Librerie e servizi. +- [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data Access Objects [DAO] e Value Objects [VO]. Classi usate per rappresentare schemi di database e facilitarne l'utilizzo per i controller. +- [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Template intelligenti usati per generare l'HTML che viene visualizzato dagli utenti. +- [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): I contenuti completi della pagina Internet. + +### frontend / www + +Contenuto: + +- js / +- css / + +#### js + +Come implica il nome, questa cartella è dove risiedono tutti i font javascript e i framework javascript. Quando vuoi apportare modifiche, per favore, minimizza il codice javascript e poi carica. + +#### css + +Analogo a js, contiene i file css minimizzati. + +### frontend / server + +Contenuto: + +- dao / +- controllers / + +Nessuno di questi moduli dovrebbe essere accessibile al mondo esterno. L'unico che può chiamarli è l'interfaccia utente. Questo è il motivo per cui sono dentro alla cartella www. + +#### DAO / VO + +La cartella _dao_ contiene le classi per il livello di accesso ai dati. Ha 2 cose da sapere: _data access objects_ e _value objects_. I _value objects_ (VO) sono niente più che classi mappate direttamente a ciascuna delle tabelle nel database. Perciò, esiste una classe lì dentro chiamata Users, siccome c'è una tabella con lo stesso nome. Questa classe ha i suoi setter e getter per ogni campo nel database. I _data access objects_ (dao) sono classi statiche per ogni tabella, e servono ad ottenere e rendere gli oggetti _vo_ persistenti. + +[Qua ci sono più informazioni su questo modello](http://www.ibm.com/developerworks/java/library/j-dao/) + +#### Controller + +I controller sono dove le decisioni sono fatte. Il controller usa i dao's e vo's per fare decisioni, e mai chiamare il database direttamente. In questo modo, si evita di avere controller separati per ogni modulo del progetto. diff --git a/it/CODE_OF_CONDUCT.md b/it/CODE_OF_CONDUCT.md index e69de29..2fb68d0 100644 --- a/it/CODE_OF_CONDUCT.md +++ b/it/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Codice di Comportamento del Collaboratore + +## Il Nostro Impegno + +Nell'interesse della promozione di un ambiente aperto e accogliente, noi +contributori e manutentori ci impegnamo a rendere la partecipazione alla nostra +comunità un'esperienza libera da molestie per tutti, indipendentemente dall'età, +corporatura, disabilità visibile o meno, etnia, +caratteristiche sessuali, identità ed espressione di genere, livello di +esperienza, istruzione, stato socio-economico, nazionalità, aspetto, razza, +religione o identità e orientamento sessuale. + +Noi ci impegniamo ad agire ed interagire per costruire una comunità aperta, +accogliente, diversificata, inclusiva e sana. + +## I nostri Standard + +Esempi di comportamenti che contribuiscono alla creazione di un ambiente +positivo per la nostra comunità: + +- Dimostrare empatia e gentilezza verso le altre persone +- Rispettare le opinioni, i punti di vista ed esperienze differenti +- Fornire, con garbo, critiche costruttive +- Prendersi la responsabilità di quanto sostenuto e scusarsi verso le persone + colpite dai nostri sbagli, imparando da queste esperienze +- Concentrarsi non su ciò che è meglio per noi come individui, ma su ciò + che è meglio per la comunità + +Esempi di comportamento inaccettabile: + +- L'uso di linguaggio o immagini sessualizzate e l'attenzione sessuale o + avance indesiderate +- Comportamenti da troll, commenti offensivi e attacchi personali o politici +- Molestie in pubblico o in privato +- Pubblicazione di informazioni private altrui, ad esempio un indirizzo postale o + elettronico, senza autorizzazione esplicita +- Altri comportamenti che potrebbero ragionevolmente essere considerati + inappropriati in un contesto professionale + +## Adempimento e Responsabilità + +Le persone alla guida della comunità sono responsabili del chiarimento e +dell'applicazione degli standard di comportamento accettabili e sono tenuti a +intraprendere azioni correttive appropriate ed eque in risposta a qualsiasi +caso di comportamento inaccettabile, minaccioso, offensivo o dannoso. + +Le persone alla guida della comunità hanno il diritto e la responsabilità di +rimuovere, modificare o rifiutare commenti, commit, codice, modifiche dei wiki, +issue e altri contributi non allineati a questo Codice di Comportamento, comunicando +le ragioni dell'intervento di moderazione quando opportuno. + +## Scopo + +Questo Codice di Comportamento si applica sia all'interno degli spazi della comunità +che negli spazi pubblici quando un individuo rappresenta la sua comunità. +Esempi di rappresentanza della nostra comunità includono l'uso di un indirizzo e-mail +ufficiale del progetto, la pubblicazione tramite un account ufficiale attraverso +social media o la funzione di rappresentante designato ad un evento online o offline. + +## Applicazione + +I casi di comportamento abusivo, molesto o altrimenti inaccettabile possono +essere presentate contattando i responsabili dell'applicazione di questo Codice di Condotta della comunità all'indirizzo [INSERISCI INDIRIZZO EMAIL]. +Tutti i reclami saranno prontamente esaminati ed indagati. + +Tutte le guide della comunità sono obbligate a mantenere la riservatezza della persona che ha riportato il caso. + +## Attribuzione + +Questo Codice di Comportamento è adattato dal [Contributor Covenant][homepage], versione 2.0, +disponibile all'indirizzo https://www.contributor-covenant.org/version/2/0/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +Per riposte a domande comuni riguardo questo codice di condotta, +controlla le domande frequenti al link https://www.contributor-covenant.org/faq. diff --git a/it/CODING_GUIDELINES.md b/it/CODING_GUIDELINES.md index e69de29..ea1b514 100644 --- a/it/CODING_GUIDELINES.md +++ b/it/CODING_GUIDELINES.md @@ -0,0 +1,24 @@ +# Linee Guida di Programmazione + +- Puoi validare che il tuo codice segua queste linee guida eseguendo `stuff/php-format.py validate` +- Tab, non spazi +- Il fine riga dovrebbe essere stile Unix (`\n`), non stile Windows (`\r\n`) +- Le parentesi aperte vanno sulla stessa riga dell'ultima istruzione + +``` + if (condition) { + stuff; + } +``` + +- Uno spazio tra parole chiave e parentesi per: `if`, `else`, `while`, `switch`, `catch`, `function` +- Chiamate di funzioni non hanno uno spazio prima delle parentesi +- Non ci sono spazi sulla sinistra dentro alle parentesi +- Uno spazio dopo ogni virgola, ma senza spazio prima +- Tutti gli operatori binari devono avere uno spazio prima e uno dopo +- Non dovrebbero esserci più di una linea vuota contigua +- Non dovrebbero esserci commenti vuoti +- Non dovresti usare commenti di blocco `/ * ... * /`, solo di linea `// ...` +- Modifiche alla funzionalità devono essere accompagnate da rispettivi test nuovi o modificati +- Eccezioni vanno usate per segnalare stati erronei. L'uso di funzioni che ritornano true / false è permesso quando sono i valori aspettati +- Usa [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) quando adeguato, principalmente nell'amministrazione di risorse (file, etc ...) diff --git a/it/CONTRIBUTING.md b/it/CONTRIBUTING.md index e69de29..6791584 100644 --- a/it/CONTRIBUTING.md +++ b/it/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Guida alla Contribuzione + +- Contribuire a The Documentation Compendium è relativamente facile. Questo documento ti illustra come iniziare + +## In Generale + +- La [Struttura della Codebase](./CODEBASE_STRUCTURE.md) haa informazioni dettagliate su come i vari file in questo progetto sono strutturati +- Per favore assicurati che ogni modifica che fai sia in accordanza con le [Linee Guida di Programmazione](./CODING_GUIDELINES.md) di questa repository. + +## Sottomettere Cambiamenti + +- Forka la repo + - +- Crea una nuova branch e dalle un nome inerente a quello che vuoi fare: + - Esempio: + ``` + $ git checkout -b NOME_BRANCH + ``` + Se riscontri un errore, potresti aver bisogno di fetchare fooBar con + ``` + $ git remote update && git fetch + ``` + - Usa una branch per fix / feature +- Committa le tue modifiche + - Per favore fornisci un messaggio git che spiega cosa hai fatto + - Per favore assicurati che i tuoi commit seguano le [convenzioni](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md) + - Committa sulla repo forkata + - Esempio: + ``` + $ git commit -am 'Aggiunto fooBar' + ``` +- Pusha sulla branch + - Esempio: + ``` + $ git push origin NOME_BRANCH + ``` +- Fai una pull request + - Assicurati di mandare la PR alla branch fooBar + - Travis CI is watching you! + +Se segui queste istruzioni, la tua PR arriverà tranquillamente nella repo principale! diff --git a/it/ISSUE_TEMPLATES/bug_report.md b/it/ISSUE_TEMPLATES/bug_report.md index e69de29..d5d90b3 100644 --- a/it/ISSUE_TEMPLATES/bug_report.md +++ b/it/ISSUE_TEMPLATES/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Segnalazione bug +about: Crea una segnalazione per aiutarci +title: "" +labels: "" +assignees: "" +--- + +**Descrivi il bug** +Una descrizione chiara e concisa del bug. + +**Per riprodurre** +Passi per riprodurre il comportamento: + +1. Vai a '...' +2. Clicca su '....' +3. Scendi fino a '....' +4. Vedi errore + +**Comportamento atteso** +Una chiara e concisa descrizione di cosa ti aspettavi succedesse. + +**Screenshot** +Se applicabile, aggiungi screenshot per aiutare a spiegare il tuo problema. + +**Desktop (per favore completa le seguenti informazioni):** + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Versione [e.g. 22] + +**Smartphone (per favore completa le seguenti informazioni):** + +- Dispositivo: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. browser predefinito, safari] +- Versione [e.g. 22] + +**Ulteriore contesto** +Aggiungi qui qualsiasi altro contesto riguardo al problema. diff --git a/it/ISSUE_TEMPLATES/custom.md b/it/ISSUE_TEMPLATES/custom.md index e69de29..840097c 100644 --- a/it/ISSUE_TEMPLATES/custom.md +++ b/it/ISSUE_TEMPLATES/custom.md @@ -0,0 +1,7 @@ +--- +name: Modello issue personalizzato +about: Descrivi qui il motivo di questo modello di issue. +title: "" +labels: "" +assignees: "" +--- diff --git a/it/ISSUE_TEMPLATES/feature_request.md b/it/ISSUE_TEMPLATES/feature_request.md index e69de29..1dff445 100644 --- a/it/ISSUE_TEMPLATES/feature_request.md +++ b/it/ISSUE_TEMPLATES/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Domanda di funzionalità +about: Suggerisci un'idea per questo progetto +title: "" +labels: "" +assignees: "" +--- + +**La tua richiesta di funzionalità è legata ad un problema? Per favore descrivi.** +Una spiegazione chiara e concisa di quale sia il problema. Ex. Sono sempre infastidito quando [...] + +**Descrivi una soluzione che ti piacerebbe** +Una spiegazione chiara e concisa di cosa vorresti che succedesse. + +**Descrivi alternative che hai considerato** +Una chiara e concisa descrizione di altre soluzioni alternative o funzionalità che hai considerato. + +**Ulteriore contesto** +Aggiungi altro contesto o screenshot riguardo alla domanda di funzionalità qui. diff --git a/it/PULL_REQUEST_TEMPLATE.md b/it/PULL_REQUEST_TEMPLATE.md index e69de29..a421764 100644 --- a/it/PULL_REQUEST_TEMPLATE.md +++ b/it/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +### La tua lista di controllo per questa pull request + +🚨 Per favore consulta le [linee guida per la contribuzione](./CONTRIBUTING.md) per questa repository. + +- [ ] Assicurati di star richiedendo di **pullare una branch topic/feature/bugfix** (lato destro). Non richiedere il master! +- [ ] Assicurati che la tua pull request sia contro la **branch fooBar** (lato sinistro). +- [ ] Controlla che i messaggi dei tuoi commit siano uniformi con la nostra struttura richiesta. +- [ ] Controlla che le tue aggiunte di codice non falliscano i test di linting né gli unit test. + +### Descrizione + +Per favore descrivi la tua pull request. + +❤️ Grazie! diff --git a/it/README_TEMPLATES/Bot.md b/it/README_TEMPLATES/Bot.md index c97aa51..d78fe06 100644 --- a/it/README_TEMPLATES/Bot.md +++ b/it/README_TEMPLATES/Bot.md @@ -21,7 +21,7 @@

-## 📝 Table of Contents +## 📝 Indice - [Descrizione](#about) - [Demo / Funzionamento](#demo) diff --git a/it/README_TEMPLATES/Minimal.md b/it/README_TEMPLATES/Minimal.md index 06f1059..02c722d 100644 --- a/it/README_TEMPLATES/Minimal.md +++ b/it/README_TEMPLATES/Minimal.md @@ -5,7 +5,7 @@ - [Descrizione](#about) - [Come Iniziare](#getting_started) - [Utilizzo](#usage) -- [Contributing](../CONTRIBUTING.md) +- [Contribuire](../CONTRIBUTING.md) ## Descrizione diff --git a/it/README_TEMPLATES/README.md b/it/README_TEMPLATES/README.md index 99bff8d..7568772 100644 --- a/it/README_TEMPLATES/README.md +++ b/it/README_TEMPLATES/README.md @@ -1,7 +1,7 @@ ### Questa cartella contiene vari modelli di README che si possono usare in base al tipo di progetto. -1. [Bot.md](/README%20Templates/Bot.md) - -2. [Hackathon.md](/README%20Templates/Hackathon.md) - -3. [IoT.md](/README%20Templates/IoT.md) - -4. [Minimal.md](/README%20Templates/Minimal.md) - -5. [Standard.md](/README%20Templates/Standard.md) - +1. [Minimal.md](/README%20Templates/Minimal.md) - Imposta velocemente un README molto basico e minimale per il tuo progetto. +2. [Standard.md](/README%20Templates/Standard.md) - Un template dettagliato e completo che copre tutti i principali aspetti di un README. +3. [Hackathon.md](/README%20Templates/Hackathon.md) - Sei ad una Hackathon e hai bisogno di impostare velocemente un README bello e approfondito che lascia un'impressione duratura sui giudici? Questo è il template per te! +4. [Bot.md](/README%20Templates/Bot.md) - Se hai creato un fantastico Bot che vuoi condividere con altri. +5. [IoT.md](/README%20Templates/IoT.md) - Questa repo illustra nel dettaglio tutti i dettagli pratici che ci sono nel documentare un progetto IoT. diff --git a/it/README_TEMPLATES/Standard.md b/it/README_TEMPLATES/Standard.md index 6e98a46..0b3a353 100644 --- a/it/README_TEMPLATES/Standard.md +++ b/it/README_TEMPLATES/Standard.md @@ -20,7 +20,7 @@

-## 📝 Table of Contents +## 📝 Indice - [Descrizione](#about) - [Come Iniziare](#getting_started) diff --git a/it/TODO.md b/it/TODO.md index f484282..62fa554 100644 --- a/it/TODO.md +++ b/it/TODO.md @@ -2,5 +2,8 @@ --- -- [ ] переводить шаблоны - +- [x] Documentare il file README.md nella cartella [README_TEMPLATES](./README_TEMPLATES). +- [ ] Fare un template IoT (Riferirsi alle varie documentazioni di progetti Arduino per assistenza). Questo template deve essere dettagliato e dovrebbe entrare nel dettaglio delle varie terminologie hardware. +- [ ] Fare un template minimal IoT. +- [ ] Aggiungere un file COMMIT_MESSAGE_GUIDELINES.md. +- [ ] Tradurre i [template](https://github.com/kylelobo/The-Documentation-Compendium#templates) in lingue diverse - Cinese, Francese, Tedesco, Hindi, Giapponese, Coreano, Portoghese, Russo, Spagnolo, etc.