diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29b..004432f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +Ciao, grazie per aver preso in considerazione di contribuire a questo progetto!
+Ci sono molti modi per farlo, e per alcuni di essi non è necessario essere uno sviluppatore. + +Puoi ad esempio [segnalare i cambiamenti di struttura](#Segnalare i cambiamenti di struttura) dei canali/server, [scrivere guide o registrare video-esempi](#Scrivere guide o registrare video-esempi) su alcune funzionalità "avanzate", dare consigli su funzionalità nuove o per migliorare quelle già presenti. + + +# Segnalare i cambiamenti di struttura +KoD, alla fine, non è altro che un browser che estrapola dai siti le info richieste secondo regole ben precise, basate sulla struttura dei siti.
+I siti web cambiano, spesso, ciò che oggi funziona domani potrebbe non più funzionare, pertanto sono fondamentali le segnalazioni, ma esse per essere realmente utili devono: +- contenere il file di log (lo potete generare andando in Aiuto - Segnala un problema e seguendo le istruzioni) +- spiegare brevemente qual'è il problema e dove, ad esempio "cineblog da errore quando entro nella sezione Film", oppure "wstream non da nessun errore ma il video di fatto non parte" +- essere replicabili, se si tratta di cose che accadono una volta ogni tanto puoi provare a segnalare lo stesso, sperando che nel log ci sia qualche indizio. Se non c'è, nada + +Sei pregato di attenerti il più possibile a quanto descritto qua perchè un semplice "non funziona" fa solo perdere tempo. +Puoi fare tutte le segnalazioni nella sezione [issues](https://github.com/kodiondemand/addon/issues), cliccando su "new issue" appariranno dei template che ti guideranno nel processo. + +# Scrivere guide o registrare video-esempi +Cerca di essere sintetico ma senza tralasciare le informazioni essenziali, una volta fatto mandalo pure sul [gruppo telegram](https://t.me/kodiondemand) taggando gli admin (@admin).
+Verrà preso in considerazione il prima possibile ed eventualmente inserito nella [wiki](https://github.com/kodiondemand/addon/wiki) o verrà creato un comando richiamabile nel gruppo. + +# Consigli +Effettuali sempre nella sezione [issues](https://github.com/kodiondemand/addon/issues), miraccomando descrivi e fai esempi pratici.
+ +# Per sviluppatori + +Di seguito tutte le info su come prendere confidenza col codice e come contribuire + +## Da dove posso partire? +Un buon punto di partenza è [la wiki](https://github.com/kodiondemand/addon/wiki), qui è presente un minimo di documentazione sul funzionamento di KoD.
+Ti consigliamo vivamente, una volta compreso il funzionamento generale dell'addon (e prima di iniziare a sviluppare), di [forkare e clonare il repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
+Questo perchè, oltre al fatto di poter iniziare a mandare modifiche sul tuo account github, l'utilizzo di git abilita la [dev mode](https://github.com/kodiondemand/addon/wiki/dev-mode), che ti sarà di aiuto nelle tue attività. + +## che cosa posso fare? +Puoi provare a fixare un bug che hai riscontrato, aggiungere un canale/server che ti interessa ecc.. +Oppure puoi guardare nella sezione [Projects](https://github.com/kodiondemand/addon/projects) cosa è previsto e iniziare a svilupparlo! + +## ho fatto le modifiche che volevo, e ora? +Pusha sul tuo fork le modifiche che hai fatto e manda una pull request. Se è la prima volta ecco qualche link che ti aiuterà: +- http://makeapullrequest.com/ +- http://www.firsttimersonly.com/ +- [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). + +Quando crei la pull request, ricordati di spiegare brevemente qual'è la modifica e perchè l'hai fatta. +Quando avremo tempo revisioneremo le modifiche, potremmo anche segnalarti alcuni problemi, nel caso prenditi pure il tutto il tempo che vuoi per sistemare (non è necessaria un'altra pull, tutti i commit verranno riportati nella prima).
+Quando sarà tutto a posto accetteremo la pull includendo le modifiche + +## Regole per le collaborazioni: +- Se si riutilizza codice proveniente da altri addon è necessario citarne la fonte, per rispetto di chi ci ha lavorato, in caso contrario il pull request verrà respinto. +- Ogni modifica o novità inviata dev'essere testata, può capitare che vi sia sfuggito qualche bug (è normale), ma l'invio di materiale senza preventivi controlli non è gradito. +- I nuovi canali devono essere funzionanti e completi di tutte le feature, comprese videoteca ed autoplay, non verranno accettati finchè non lo saranno. diff --git a/README.md b/README.md index 16e630af..18a7fcba 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,16 @@ # Kodi On Demand ### Un fork italiano di [Alfa](https://github.com/alfa-addon) -Ognuno è libero (anzi, invitato!) a collaborare, per farlo è possibile utilizzare i pull request. -KOD funziona con Kodi fino alla versione 18 (Python 2). -KOD, come Alfa, è sotto licenza GPL v3, pertanto siete liberi di utilizzare parte del codice, a patto di rispettare i termini di suddetta licenza, che si possono riassumere in: +Installazione: https://kodiondemand.github.io/#download + +KoD attualmente funziona con Kodi fino alla versione 18 (Python 2). + + +KoD, come Alfa, è sotto licenza GPL v3, pertanto siete liberi di utilizzare parte del codice, a patto di rispettare i termini di suddetta licenza, che si possono riassumere in: - Il tuo addon deve essere rilasciando secondo la stessa licenza, ovvero essere open source (il fatto che lo zip sia visibile da chiunque non ha importanza, è necessario avere un repository git come questo) - Aggiungere i crediti a tutto ciò che copiate/modificate, ad esempio aggiungendo un commento nel file in questione o, meglio, facendo un cherry-pick (in modo da preservarnee lo storico) -### Come contribuire? -- Fai un Fork del repository. -- Effettua tutte le modifiche e fai un push nel tuo repository remoto. -- Testa tutte le funzioni principali (videoteca, autoplay, scraper web) o eventuali aggiunte extra. -- Apri una pull request. -Regole per le collaborazioni: -- Se si riutilizza codice proveniente da altri addon è necessario citarne la fonte, per rispetto di chi ci ha lavorato, in caso contrario il pull request verrà respinto. -- Ogni modifica o novità inviata dev'essere testata, può capitare che vi sia sfuggito qualche bug (è normale), ma l'invio di materiale senza preventivi controlli non è gradito. -- I nuovi canali devono essere funzionanti e completi di tutte le feature, comprese videoteca ed autoplay, non verranno accettati finchè non lo saranno. - -Se parte del codice di un tuo addon è stato incluso in questo progetto e ne desideri l'eliminazione, crea una issue portando le prove di essere veramente uno dei dev e lo elimineremo. - -### Qualcosa non funziona? -Sentiti libero di segnalarlo al team [qui](https://github.com/kodiondemand/addon/issues) +### Come contribuire o fare segnalazioni? +Ti piace il progetto e vuoi dare una mano? Leggi [qui](https://github.com/kodiondemand/addon/blob/master/CONTRIBUTING.md)