Utente:Valerio Bozzolan/Requisiti software

Questa è una bozza. Gli utenti registrati sono invitati a migliorare questa pagina in qualsiasi momento.

Guida per i progetti di sviluppo software sostenuti, finanziati o commissionati da Wikimedia Italia.

Preambolo

Wikimedia Italia gestisce centinaia e centinana di software e ringrazia chi seguirà queste indicazioni per rimanere collaborativi con il resto della comunità, prendendosi cura del proprio progetto affinché duri nel tempo.

In breve

I professionisti che collaborano per aiutare i volontari dei progetti Wikimedia e Wikimedia Italia sono incoraggiati a contribuire con spirito sociale e collaborativo in linea con il movimento per il software libero:

• #Pubblicazione del codice sorgente su GitLab o GitHub
• #Documentazione del progetto incoraggiando correzioni e ampliamenti puntando ad un pubblico senza particolari conoscenze pregresse sul tema. Sezioni suggerite per il file README.md:
  • About: cos'è il progetto, come nasce, come si struttura, ecc.
  • Contribute: come si suggerisce di contribuire al progetto
  • Contact: chi sono i referenti del progetto e chi contattare in futuro quando terminerà il progetto
  • License: crediti ai contributori e nota sulla #Licenza libera

Pubblicazione

Si richiede che l'autore si prenda cura della pubblicazione del codice sorgente e della documentazione correlata in almeno una piattaforma sociale facilmente accessibile pubblicamente come GitLab, Phabricator, Gerrit, GitWeb, SourceHut, GitHub.

Controllo versione

Si richiede che il codice sorgente sia sotto controllo versione, suggerendo fortemente git, dato che è lo standard de facto.

Suggerimenti:

• https://git-scm.com/docs/git-commit#_discussion
• https://chris.beams.io/posts/git-commit/

Non saranno accettabili strumenti di controllo versione proprietari o strumenti di controllo versione ormai in disuso. Altri strumenti di controllo versione liberi sono Subversion, Bazaar o Mercurial ma si richiede di motivare la loro adozione.

Documentazione

Si richiede che il progetto abbia una curata documentazione che permetta e faciliti le persone a comprendere lo scopo del progetto, la sua struttura, come contribuire, chi poter contattare in caso di bisogno e la licenza.

Sezioni suggerite per il file README.md:

• About
• Contribute
• Contact
• License

La documentazione va bene anche in formato Markdown direttamente nel repository, o qualsiasi altro formato o piattaforma libera che ne incoraggi l'ampliamento o la traduzione.

La lingua preferita per la documentazione tecnica è l'inglese. La lingua preferita per la documentazione utente è l'italiano.

Licenza libera

Il progetto software deve incoraggiare modifica e condivisione, anche nei materiali multimediali.

Quando si è gli autori e si deve scegliere una nuova licenza, si può usare questo prospetto:

• software lato-server: GNU AGPL v3+
• software generico: GNU GPL v3+
• piccolo script: Licenza MIT
• materiale multimediale creativo: CC BY-SA
• materiale poco creativo: CC BY
• dataset: CC 0