Contribuer au code
If you want to contribute to this project you are very welcome. Please don’t hesitate to contact us or to grab our code on Github
C’est une question qui revient souvent pour les projets open-source. Comment peut-on obtenir le code et comment peut-on y participer. En effet, vous êtes nombreux à utiliser le code du Bilboplanet, mais chacun d’entre vous, en fonction de vos besoins, vous adaptez une partie du code de manière à en faire votre planet personnalisé.
Seulement voilà, parfois on a envie de partager ce travail qui finalement pourrait aussi profiter à la communauté. C’est pourquoi nous avons créé un compte sur Github pour vous permettre de participer au projet. Mais il est évidement que vous n’êtes pas tous habitués à Git et Github. Voici donc une petite explication (simple) vous permettant de participer au projet aussi souvent que vous le souhaitez !
Sommaire |
Prérequis
- Disposer d'un compte utilisateur sur github
- Avoir installé git sur votre pc
- Avoir un accès Internet
- Ce tutorial est destiné aux utilisateurs de linux
"Forker" le projet Bilboplanet
Se rentre sur la branche principale du projet (https://github.com/theclimber/Bilboplanet)et cliquer sur le bouton 
.
Ceci aura pour effet de créer un nouveau "repository" sour votre compte utilisateur qui sera accessible au travers de l'adresse https://github.com/YOUR_USERNAME/Bilboplanet
Récupérer le code courant
Maintenant que vous avez le code du projet sous votre compte github, vous pouvez récupérer une copie de celui-ci en local sur votre poste de travail: Si vous avez mis en place une clé ssh sous votre compte vous pouvez le faire avec la commande suivante
$ git clone https://github.com/YOUR_USERNAME/Bilboplanet.gitDans le cas contraire:
NB: Vous serez invité à saisir le mot de passe de votre compte utilisateur Github
Une fois la copie du terminé, nous allons configuré notre fork afin d'y donner un nouveau nom "upstream" afin de garder une trace du dépôt source "origin" :
$ cd Bilboplanet$ git remote add upstream git://github.com/YOUR_USERNAME/Bilboplanet.git$ git fetch upstreamModifier le code
A ce stade vous pouvez travailler sur le code téléchargé. Cela n'aura aucun impact sur le code hébergé sur Github tant que celui-ci n'aura pas été transféré.
Commiter le code
Une fois les modifications apportées au code, il faut s'assurer que les modifications vont être prises en compte:
$ git status
$ git add admin/le_fichier_modifier
$ git add admin/meta/js/le_fichier_ajouter
$ git status
Une fois que c'est bon on peut procédér au "commit" :
$ git commit -m "Je décris brièvement ce que j'ai fait"Envoyer le code sur votre repository
A ce stade nous allons envoyé le code modifié sur le repository Bilboplanet de votre compte github. Cette opération est sans risque car elle n'écrase pas les fichiers existants, il sera donc tout a fait possible de corriger le code si une erreur est présente ou même de revenir en arrière.
$ git push origin masterUne fois le transfert terminé, on peut vérifier nos modifications au travers de la page web du projet de votre compte utilisateur https://github.com/YOUR_USERNAME/Bilboplanet.
Soumettre votre contribution au projet
Le fait de soumettre votre code au projet s'appelle un "Pull Request", cette opération se fait sur la page de votre projet https://github.com/YOUR_USERNAME/Bilboplanet en cliquant sur le bouton "Pull Request" 
et en suivant le guide (veillez à bien renseigner les informations demandées).
Attendre la validation d'un administrateur
Une fois que tu as proposé le merge avec un pull request, un développeur va relire ton code et va,peut être, l'intégrer dans le code principal du Bilboplanet.
Nous vous remercions d'avance de votre contribution.
Liens intéressants
- Les bonnes pratiques: Bonne pratiques pour utiliser Git
- Utiliser Github par NicoLargo : http://blog.nicolargo.com/2011/11/contribuer-a-un-projet-heberge-sur-github.html
- Fork a repo : http://help.github.com/fork-a-repo/
- Send pull requests: http://help.github.com/send-pull-requests/
