Procédures

Procédures

Pour participer au projet, merci de suivre les instructions suivantes

À effectuer une seule fois au début du projet

1. Créer un compte GitHub et s'y connecter
2. Informer le responsable du projet de votre identifiant GitHub
3. Effectuer un fork du dépôt principal
4. Télécharger et installer Git depuis le site officiel
5. Cloner votre fork en local (grâce à la commande git clone https://github.com/[VOTRE IDENTIFIANT GITHUB]/enigmos.git enigmos)
6. Ajouter le dépôt principal au projet local sous le nom « upstream » (depuis le dépôt local : git remote add upstream https://github.com/CPLN/enigmos.git)
7. Configurer Git en précisant votre nom et votre adresse e-mail dans les configurations (Deux commandes : git config --global user.name "[VOTRE NOM]" et git config --global user.email [VOTRE ADRESSE E-MAIL])

Résumé des commandes (points 5 à 7)

git clone https://github.com/[VOTRE-IDENTIFIANT-GITHUB]/enigmos.git enigmos
cd enigmos
git remote add upstream https://github.com/CPLN/enigmos.git
git config --global user.name "[VOTRE NOM]"
git config --global user.email [VOTRE ADRESSE E-MAIL]

Pour développer une nouvelle énigme

1. Se rendre sur le dépôt principal et proposer une nouvelle énigme dans les issues (optionnel)
2. Sélectionner une issue non-attribuée et demander au responsable du projet de vous l’attribuer
3. Créer votre énigme en vous référant aux conventions en vigueur
4. Effectuer un pull request et attendre qu’il soit validé. Le cas échéant, appliquer les modifications indiquées

À chaque session de travail

1. Effectuer un fetch de « origin » et « upstream » (git fetch --all)
2. Effectuer un merge de ces deux dépôts au besoin, éventuellement régler les conflits (git merge upstream/master, puis git merge origin/master)
3. Travailler en effectuant des commits très fréquents, une unité de travail = un commit (git add -A, puis git commit -m "[MESSAGE DE COMMIT]")
4. En fin de session, effectuer un push vers « origin » (git push)