Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 6.83 KB

contributing.md

File metadata and controls

76 lines (49 loc) · 6.83 KB
Raw

Nota del traduttore

Questa è la traduzione del file contributing.md. Qui c'è il link dove si confrontano le differenze tra commit di riferimento di questa traduzione e l'ultimo commit di AVA sul branch master (Se si clicca sul link, e non si vede il file contributing.md nella lista dei file modificati, questa traduzione è aggiornata).

Contribuire ad AVA

✨ Grazie per contribuire ad AVA! ✨

Considera che questo progetto utilizza un Codice di Condotta per i Collaboratori. Partecipando al progetto accetti i suoi termini e condizioni.

Traduzioni: Español, Français, 日本語, Portugués

Come posso contribuire?

Migliora la documentazione

Come utente di AVA tu sei il perfetto candidato per aiutarci a migliorare la nostra documentazione. Correzioni ortografiche, correzione di errori, migliorare le spiegazioni, più esempi, etc... Apri nuove issue se trovi errori o per suggerire miglioramenti. Aiutaci a tradurre la documentazione. Ogni aiuto è il benvenuto. Anche migliorare questa stessa documentazione.

Usa la targhetta docs per trovare consigli su cosa vorremmo vedere documentato.

Migliora le issues

Alcune issue vengono create senza tutte le informazioni importanti, oppure non sono riproducibili, o semplicemente non valide. Aiutaci a migliorarle per risolvere rapidamente e meglio. Occuparsi delle issues richiede molto tempo che potremmo invece spendere nel risolvere bug o per aggiungere nuove funzionalità.

Dai il tuo feedback nelle issues

Siamo sempre alla ricerca di diverse opinioni nell'issue tracker. È una buona opportunità per influenzare le future decisioni di AVA.

La targhetta question è un buon punto di partenza per trovare discussioni attive.

+### Scrivere codice

Puoi usare le targhette delle issues per aiutarci:

  • babel sono issues inerenti la nostra infrastruttura Babel
  • blocked sono issues alla ricerca di una mano per essere sbloccate
  • bug sono issues riconosciute come bug che vorremmo risolvere
  • enhancement sono miglioramenti che stiamo considerando di includere
  • performance idee su come migliorare le prestazioni di AVA

Le help wanted e good for beginner sono perticolarmente utili.

Potresti trovare una issue già assegnata, o che abbia la targhetta assigned. Prima di iniziare su questo tipo di issue controlla che non qualcun altro non abbia già iniziato a lavorarci.

Preferiremmo correggere le issues priority per prime. Ci piacerebbe vedere andare avanti anche issues low-priority. Le issue future sono quelle che ci piacerebbe avere, ma più in là. Controlla prima di iniziare a lavorare su quest'ultime poichè potremmo aver deciso di non supportarle ancora per il momento.

Passa nella nostra chat

Abbiamo una chat. Visita e dai un'occhiata, parla con noi ed aiuta chi ne ha bisogno.

Notifica un issue

  • L'issue tracker è per le issue (bug, etc...). Utilizza la nostra chat o Stack Overflow per il supporto.
  • Cerca se già esiste l'issue o bug che hai prima di aprirne uno nuovo.
  • Assicurati di usare l'ultima versione di AVA.
  • Utilizza un titolo per l'issue chiaro e descrittivo.
  • Inserisci più informazioni che puoi: passi per riprodurre il problema, messaggio di errore, versione Node.js, sistema operativo, etc...
  • Più tempo ci impieghi per scrivere una issue, più tempo ce ne impiegheremo noi per risolverla.
  • Il miglior tipo di issue che puoi inviare è provarlo con un test che fallisce.

Invia una pull request

  • È meglio discutere cambiamenti non banali in una issue prima di inviare una PR, per evitarti spesso lavoro non necessario.
  • Per cambiamenti ambiziosi, cerca di portare il tuo lavoro davanti la comunità per un feedback il prima possibile. Invia una pull request non appena hai lo stretto necessario per dimostrare la tua idea. In questa prima fase non preoccuparti di fare tutto perfetto, o completo al 100%. Aggiungi il prefisso [WIP] nel titolo e descrivi cosa manca ancora. Questo permette a reviewer di sapere che non è necessario essere troppo puntigliosi o proporre miglioramenti che hai già in piano di fare.
  • Nuove funzionalità devono essere supportate da test e documentazione.
  • Non includere cambiamenti non necessari alla funzionalità.
  • Verifica con Lint il codice e testalo prima di inviare la pull request eseguendo $ npm test
  • Crea la pull request da una branch dedicata, non master.
  • Usa un titolo chiaro e descrittivo per la pull request ed i commit.
  • Scrivi una descrizione che ci convinca sul perchè dovremmo accettare la tua pull request. È il tuo lavoro convincerci. Fornisci il "perché" sia necessaria e fornisci dei casi d'uso.
  • Potremmo chiederti di fare dei cambiamenti alla tua pull request. Non c'è bisogno di aprire una nuova pull request, semplicemente aggiorna quella già aperta.

Attenzione: quando fai modifiche al codice, ricorda che il mantra di AVA (preso da Python) è avere preferibilmente un unico modo di fare qualcosa. Ad esempio, una pull request per aggiungere un alias per una parte dell'API (come questo)) sarà molto probabilmente rifiutata se non introduce qualche ulteriore beneficio.

Stai cercando un progetto open source a cui contribuire? Eccolo! AVA è un progetto con una comunità accogliente su Internet. Dai un'occhiata al blog post "Making your first contribution" per avere un'idea di come iniziare e contribuire ad AVA!