Documentation Contributeurs
Cette documentation a pour but de mettre en place des règles spécifiques pour les contributions au code du CMS Nuked-klan. Il est important de bien respecter les différents points suivants afin d'assurer la validation de votre travail. En effet, tout commit ou pull-request ne respectant pas ces critères sera purement et simplement supprimé.
Le dépôt officiel comprends des branches permanentes ainsi que des branches semi-permanentes. La gestion des branches sur ce dépôt est exclusivement réservée aux validateurs du Staff NK.
- master : Branche contenant les versions stables et disponibles au téléchargement.
- fix : Branche contenant uniquement les corrections de bugs/failles de sécurité des versions stables.
- develop_1.x : Branche contenant la version 1.x actuellement en développement.
- bugs_1.x : Branche contenant uniquement les corrections de bugs de la version 1.x en développement
- develop_2.x : Branche contenant la version 2.x actuellement en développement.
- bugs_2.x : Branche contenant uniquement les corrections de bugs de la version 2.x en développement
- develop_SPx : Branche contenant la version SPx actuellement en développement.
- bugs_SPx : Branche contenant uniquement les corrections de bugs de la version SPx en développement
- version_feature_nom : Branche contenant uniquement un module, une fonctionnalité, un patch nommé "nom".
Les branches semi-permanentes, servent uniquement à proposer le développement d'un module, d'une fonctionnalité, etc sur le dépôt officiel afin de centraliser et développer à plusieurs sur le dépôt NK.
Ces branches ne peuvent être créer que par des administrateurs, de ce fait pour la création d'une nouvelle branche, veuillez en faire la demande à l'adresse developers[a]nuked-klan.org (Délai moyen de réponse 48H)
Exemple :
Thomas et Nicolas, souhaitent contribuer au CMS Nuked-klan, ils ont le projet de créer un module "Chasse & Pêche". Toutefois, ils veulent rendre accessible leur code au plus grand nombre, et pourquoi pas obtenir de l'aide d'autres développeurs. Dans ce schéma, plutôt que de créer une branche sur leurs dépôts personnels. Il font la demande auprès des administrateurs NK afin de créer la branche "features_mod_chassepeche" sur le dépôt officiel de Nuked-Klan, ils pourront ainsi travailler sur leurs forks et proposer leur code dans la branche du dépôt NK.
ATTENTION : Toutes les manipulations suivantes nécessite un compte actif sur www.github.com
Rendez-vous sur la page du dépôt officiel de Nuked-klan :
https://github.com/Nuked-Klan/CMS_Nuked-Klan
Cliquer sur le bouton "Fork" en haut à droite de la page (Figure 1).
Après une petite animation, votre fork est désormais créé et disponible dans vos dépôt personnel de votre compte GitHub. La page d'accueil de ce nouveau dépôt vous indique les étapes à suivre pour créer un clone local de votre fork. Nous détaillerons ces démarches dans l'étape suivante.
Votre fork est désormais disponible à cette adresse :
https://github.com/nom_de_compte/CMS_Nuked-Klan
INFO : Nous considérons ici que git est déjà configuré sur votre machine.
# On se place dans le dossier de son choix, ici on utilisera /home/Votre_nom/Github
$ cd /home/Votre_nom/Github
# Vous cloner ensuite votre dépôt
$ git clone https://github.com/Votre_nom/CMS_Nuked-Klan.git
Si vous préférez l'utilisation d'une interface graphique à la ligne de commande, nous vous recommandons fortement le logiciel SourceTree. Ce dernier est relativement simple d'utilisation mais permet également d'effectuer des tâches plus complexes assez simplement.
INFO : Nous considérons ici que vous avez installé SourceTree
Une fois le logiciel ouvert cliquer sur le bouton de "clone" en haut a gauche
Une fenêtre de configuration du clone s'ouvre remplissez-la comme sur l'image
Configuration du clone :
- Source Path / URL : Saisissez ici l'url de votre fork
- Destination Path : Saisissez le dossier local dans lequel vous voulez cloner votre fork
- Name : Saisissez le nom de votre clone (pré-rempli automatiquement)
Enfin cliquer sur clone pour démarrer votre clonage
Une fois le clonage terminé, vous obtenez ceci :
