Contribuire al progetto GDRCD

Contribuire al progetto GDRCD postato il 09/06/2011 14:09:38 nel forum programmazione, gdrcd e open source e modificato da blancks il 02/03/2014 22:44:03

Questo topic serve ad orientare chi è intenzionato a dare in qualche modo il suo contributo al progetto, elencando di seguito le varie possibilità e modalità al fine di ottimizzare l'apporto di aiuti.

Voglio chiarire in anticipo che contribuire non significa necessariamente programmare, ho diviso pertanto in cateogorie i possibili tipi di aiuto che potete fornire, programmatori o meno ;-)



Ultima Release

La versione attualmente più aggiornata del pacchetto è GDRCD 5.2 e al seguente link potrete scaricare sempre la release più aggiornata.
Sia che vogliate contribuire allo sviluppo o sia che vogliate creare un vostro gdr online, è importante munirsi della versione più aggiornata al fine di usufruire di tutti i benefici che questo comporta sotto gli aspetto sicurezza, bugfix e stabilità oltre alle eventuali nuove features presenti.

Download GDRCD 5.2 https://github.com/GDRCD/GDRCD/archive/master.zip



Ambito di Sviluppo

Sei un programmatore, un aspirante tale o uno smanettone per hobby che ha volontà di dedicare al progetto le proprie attenzioni ?
Puoi cimentarti nella realizzazione di plugin per rilasciare funzionalità aggiuntive o patch per la correzione di alcune problematiche dell'engine a tua discrezione, solo devi tener conto che il software che stai scrivendo non è per tuo uso personale ma andrà condiviso con tutti gli utenti che vogliono poterlo utilizzare, pertanto è di fondamentale importanza che vengano seguite alcune regole di modo che il tuo operato sia compatibile con la filosofia di sviluppo del CMS.

Prima di elencare di seguito le regole secondo la filosofia di sviluppo del codice, forse è meglio fare un chiarimento tra plugin e patch e chiarire il ruolo di Github nello sviluppo del progetto.

Il plugin è un estensione delle funzionalità del codice, un pacchetto aggiuntivo che implementa nuove funzioni ed aumenta le possibilità di personalizzazione dell'engine.

Una patch è una correzione di un file esistente o l'aggiunta di nuovi files mirati alla risoluzione di bug che sono sfuggiti ai controlli durante le varie fasi di produzione del software.

Per quanto riguarda Github, si tratta di una piattaforma che permette ai vari sviluppatori di unire gli sforzi sotto un unico fronte.
Se stai sviluppando un plugin o una patch è bene fare un fork del progetto e lavorare in questo modo alle proprie implementazioni in parallelo al progetto originale, da cui si continueranno a ricevere aggiornamenti.

Qualunque sia il tipo di implementazione che si sta andando a fare, l'importante è seguire alcune semplici regole in modo da garantire uno sviluppo coerente del progetto.

1) Non reinventare la ruota.
GDRCD, dalla versione 5.0, include nativamente un core con delle funzioni base standardizzate per l'engine. E' fondamentale che vengano usate queste quando possibile che non riscriverle da capo seguendo altre logiche e/o ragionamenti che portino allo stesso risultato, sarebbe solo un inutile sparpagliamento di risorse.
Ricordo che tra le funzioni probabilmente più utili di cui dispone il core di GDRCD, sono presenti il filtro per gli input utente

gdrcd_filter($filterType, $filterString);

e il gestore centralizzato delle query SQL

gdrcd_query($SQL, $requestType);

Altra chicca è il file upgrade_list.php che trovate nella directory di root del software, in sostanza se i vostri componenti aggiuntivi hanno bisogno di applicare nuove colonne a qualche tabella nel database è possibile rilasciare una versione aggiornata di questo file con la dichiarazione delle colonne da includere e l'installer automatico di gdrcd chiederà all'utente l'aggiornamento del database.

2) Configurabilità
Il plugin deve essere soggetto a impostazioni del foglio di configurazione che permettano di disabilitarne l'uso o di configurarlo al meglio se particolarmente evoluto (per un esempio basti vedere il plugin nativo rilasciato nella versione 5.1 col BBDecoder).
E' chiaro che tali impostazioni di configurazione vadano create, rilasciatele quindi in un file .txt di modo che l'utilizzatore del plugin possa copiarle nel suo file di config.inc.php
Nel caso necessiti di ampliare il file di vocabolario, fare la stessa anche in questo caso.

4) Documentazione
Fornite sempre spiegazioni dettagliate su:
- Installazione del plugin
- Funzionalità incluse
- Configurazione dei settaggi

5) Librerie aggiuntive
Potrebbe capitare che alcuni plugins siano molto evoluti e richiedano l'inclusione di librerie aggiuntive per il suo funzionamento.
Tale libreria deve seguire le regole di configurazione in quanto, se la funzionalità viene esclusa, non deve risultare venire inclusa inutilmente lato codice.
Inoltre bisogna allocare le librerie obbligatoriamente nella directory plugins/nomeplugin/, da questo percorso in poi se è inclusa li o in un sistema di ulteriori sottocartelle è a vostra discrezione.

6) Buon senso
E' inutile cimentarsi in cose più grandi di se, per una questione di buon senso se si sa di aver proceduto per tentativi nella realizzazione di qualcosa che ci si è poi ritrovata funzionante senza sapere come e perché evitate di pubblicarla.

Nel caso in cui stiate pubblicando un fix per un particolare problema, vi consiglierei di seguire anche i seguenti punti:

7) Accuratezza
Specificare chiaramente il problema per cui viene rilasciato questo fix, e commentare il codice nelle sezioni in cui si è eseguita l'operazione di modifica con la seguente sintassi:

/** * Descrizione del fix
* @author NomeAutore
*/

8) Competenze
Assicuratevi di esser certi di quello che fate, un bug è facile da correggere ma produrre un problema più grave per correggere una sciocchezza lo è altrettanto, pertanto sarebbe preferibile che chi rilasci una patch sia certo di averla testata a dovere o sappia per filo e per segno quello che sta facendo.



Ambito Grafico

GDRCD ha la peculiarità di poter essere graficamente interamente customizzato mediante l'uso di skin che si compongono con un insieme di fogli di stile CSS.
Potete quindi creare le composizioni che più preferite e rilasciarle come tema alternativo di base.

Non c'è una filosofia ben precisa da seguire, se non rispettare l'elenco dei files necessari e non particolarizzare troppo le skin in quanto sono da intendersi ad uso generico di base per arrivare al fine (la creazione della land) e non come il fine stesso in quanto ogni land deve particolarizzarsi ;-)



Ambito Documentativo

Il progetto, attualmente conta molte funzionalità e scarse descrizioni fornite nelle pagine mediante qualche riga molto indicativa di testo.
Se hai voglia di partecipare al progetto sappi che non è necessario essere solo programmatori, ma anche delle persone che sappiano scrivere in italiano corretto e in maniera molto chiara al fine di produrre una documentazione che possa facilitare l'utilizzo del codice.
Potete testare su un vostro spazio il codice, fare le prove che volete per capire come funzionano le varie cose o chiedere personalmente a me via email o messaggio privato ulteriori delucidazioni, non si parla di un funzionamento a livello di programmazione ma a livello di comportamento delle varie funzioni: ad esempio come si crea una nuova locazione, come imposto le tooltip, etc.

Tutto il materiale documentativo così raccolto, può essere organizzato e inserito nella wiki offerta da github https://github.com/GDRCD/GDRCD/wiki.

Potete segnalare l'eventuale materiale da voi prodotto a

. blancks
. breaker
. leoblacksoul



Ambito di Test

Sei un utilizzatore assiduo del CMS? Hai riscontrato malfunzionamenti ? Contribuire al progetto è anche segnalare questo tipo di problematiche, non solo mettersi in parte attiva a programmare o documentare.

Puoi segnalare tutte le problematiche che saltano fuori su github, nell'issue tracker dedicato al progetto https://github.com/GDRCD/GDRCD/issues, in questo modo riuscirai a fornire un contributo utile che ci permetterà di correggere al più presto eventuali problemi.



Grazie per esserti interessato alla questione, per qualsiasi dubbio è sufficiente postare sotto il topic, così che si possa migliorare anche questa bozza che ho scritto.

quota

09/06/2011 15:02:05

L'ambito grafico è mio! *-*

volo subito, l'iniziativa mi piace da morire e ci lavorerò sicuramente per dare il mio contributo al progetto.

bellissima idea come sempre ;) ( ormai mi mancano solo i pon-pon nella firma del forum, e poi sono una blancks supporter ufficiale XD )

---

• • •

quota

09/06/2011 15:12:46

quesse ha scritto: L'ambito grafico è mio! *-*

volo subito, l'iniziativa mi piace da morire e ci lavorerò sicuramente per dare il mio contributo al progetto.

bellissima idea come sempre ;) ( ormai mi mancano solo i pon-pon nella firma del forum, e poi sono una blancks supporter ufficiale XD )

Ma LoL!

Ad ogni modo, per ulteriore chiarezza, tutti gli ambiti sono aperti a chiunque volesse contribuire se ritiene di averne le capacità.

L'unica per cui ci vorrebbe una figura ben distinta e per cui ho chiesto un volontario, è il ruolo di un possibile coordinatore/responsabile che si occupi di scrivere/raccogliere/revisionare/correggere le informazioni che gli verranno passate per la documentazione.
Se è ingrado di infilarle in un sito tanto meglio pure :p

quota

09/06/2011 15:30:00

clemence ha scritto: Mi offro come programmatore!


scherzo :P

L'ho capito da quando ho letto "programmatore" u.u"

quota

09/06/2011 17:09:51

Ci piace, bell'idea ;)

quota

09/06/2011 20:05:08

Bell'idea Blanks! E sicuramente i tuoi suggerimenti sono molto utili.
*-* ho già in mente una paio di modifiche (Permessi Dinamici, Gestione Avanzata del Forum) che vorrei poter aggiungere quando trovo il tempo necessario.

---

---
Non chiedetemi aiuto in privato per questioni di programmazione; chiedete sul forum e eventualmente vi risponderò lì.
http://gdrportal.eu - Hosting per GDR

quota

09/06/2011 20:57:02

va come cresce il progetto ^^ sono commosso!

---

Homo Faber Fortunae Suae

quota

10/06/2011 01:49:08 e modificato da owli1 il 10/06/2011 01:49:31

Mi offro come motivatore e ragazza ponpon!

Modificato per: E' per dire che seguiro per bene la cosa dato che forse potrebbe interessarmi più avanti.

---

💀 Utente di servizio a cui vengono attribuiti i post sul forum di utenti che si sono cancellati 💀

quota

10/06/2011 11:19:44

owli1 ha scritto: Mi offro come motivatore e ragazza ponpon!

Modificato per: E' per dire che seguiro per bene la cosa dato che forse potrebbe interessarmi più avanti.

Avevo paura che ti offrissi per coccolare il quarterback o peggio per salvare il mondo lol.

quota

10/06/2011 14:02:55

scusate ragazzi... ma non vi sembra che state andando un pò oltre con questo gdrcd?
ok il voler aiutare chi vuole diventare Gestore senza che ci siano conoscenze programmative, etc... ma così non credete di demoralizzare chi vuole fare una land da zero (dato che per farne una ci si impiega qualche anno... invece se installi il gdrcd ci metti 5 minuti) o incentivare sempre più land uguali/fotocopia(se mettete un pò di tutto, senza dar modo di implementare da soli alcuni miglioramenti e funzioni, la gente seriamente appena gli gira 5 minuti apre 300 land rimanendo comodi nella sdraio) ?

basta già il mondo reale dove ci troviamo donne siliconate e botulinate che diventano tutte uguali stile Cinesi, facendo perdere il fascino del naturale "come mamma ti ha fatto"...non roviniamo anche i Giochi, date solo una versione BASE con l'essenziale (struttura, skin iniziale, criptazione delle password...), lasciando alla gestione o staff di implementare successivamente la land con la loro creatività.

parere da esterna eh..
(so che riceverò critiche con questa mia uscita,dato che molti amano questo pacchetto che ti permette di non fare il 60/80% delle cose, ma incasserò senza problemi :P)

---

Link Gioco: http://www.dreamofyou.it - Link Scheda http://www.gdr-online.com/dreamofyou.asp

quota

10/06/2011 14:18:48

Ottima inziativa blanks.
Mi offro come moderatore intanto, anche se non mi dispiacerebbe fare il gestore.

Eventualmente mi vendo come pacchetto aggiuntivo al GDRCD.

quota