Wiki Contribution

Guida per aggiornare la pagina Wiki di 1Hive.

1Hive è un grande ecosistema tentacolare, composto da diversi progetti che sono in continuo sviluppo. Mantenere una pagina Wiki è importante per assicurare che ci sia sempre una panoramica completa di tutto ciò che circonda 1Hive. Tutti gli utenti sono incoraggiati a contribuire all’aggiornamento costante di questa pagina.

Almeno un membro da ogni swarm (sciame) avrà i permessi per accedere e aggiornare la pagina wiki, per garantire che i dettagli e i progetti riguardanti lo swarm (sciame) siano accurati.

Chiunque non abbia accesso in scrittura può comunque aggiornare una pagina sul Wiki, o la struttura, e può farlo attraverso una pull request su Github.

Editare la pagina Wiki utilizzando Github

Configurazione Iniziale

  1. Per editare una pagina senza un esplicito accesso in scrittura si necessita di un account Github. E’ possibile creare un nuovo account su http://github.com/

  2. Fare un Fork del Wiki dall’organizzazione 1Hive Github al proprio account Github andando sul seguente link e cliccando fork in alto a destra https://github.com/1Hive/wiki

Passaggi successivi

  1. All’interno del Wiki repo appena forkato sul proprio account Github, è possibile navigare sul file che si desidera modificare ed editare direttamente nel proprio web browser cliccando sull’icona della matita in alto a destra del bordo del file. Ogni file rappresenta una pagina sul Wiki, i nomi dovrebbero rappresentare gli stessi presenti nel Wiki website.

  2. Usare il markdown di Github per formattare la propria modifica: https://guides.github.com/features/mastering-markdown/

  3. Qualora si stia aggiungendo una nuova pagina, assicurarsi di collegarsi ad essa dal file SUMMARY.md

  4. Confermare la modifica scorrendo fino in fondo, inserendo un messaggio di commit e facendo clic su Commit.

  5. Creare una pull request (PR) contro il repository wiki 1Hive facendo clic su Pull Requests -> Nuova Pull Request. N.B. Il repository di base dovrebbe essere 1Hive/wiki e la base dovrebbe essere master. Clicca “Create Pull Request”.

  6. Aggiungere un titolo e una descrizione riguardo una modifica e cliccare su Create Pull Request

  7. La PR su 1Hive Wiki repo è stata creata con successo. Ora bisognerà attendere una review da parte di un membro dell’organizzazione 1Hive Github. I recensori potrebbero lasciare dei commenti, quindi è necessario controllare la propria mail o controllare la pagina qualora una risposta sia richiesta.

  8. Qualora si necessiti un update successivamente ad un commento di un recensore, basta aggiornare il file come fatto inizialmente e le modifiche dovrebbero essere nuovamente sulla PR.

  9. Una volta che la Pull Request è considerata accettabile verrà unita (merged) nella pagina Wiki da uno dei recensori.

Last updated