Commit b1079627 authored by Erwan Bousse's avatar Erwan Bousse
Browse files

README: ajout partie rendu + quelques conseils

parent 86497de8
......@@ -9,7 +9,7 @@ L'objectif de ce mini-projet est d'intégrer et adapter tout le travail réalis
## Préparation
1. Créez une fourche (Fork) du project sur votre compte GitLab: [Cliquez ici pour créer le Fork](https://gitlab.univ-nantes.fr/naomod/software-development-course/onlineChess/forks/new) (Éventuellement, Gitlab vous demandera de vous connecter).
1. Créez une divergence (en anglais, *fork*) du projet sur votre compte GitLab: [Cliquez ici pour créer le Fork](https://gitlab.univ-nantes.fr/naomod/software-development-course/onlineChess/forks/new) (Éventuellement, Gitlab vous demandera de vous connecter).
2. Créez et configurez une copie locale du projet. Ouvrez le **Terminal** et exécutez les commandes suivantes:
......@@ -137,14 +137,30 @@ Par exemple, pour tester
### Rendu
L'ensemble de votre projet doit être archivé au format zip et déposé sur Madoc au format
\begin{center}\verb+NOM1_NOM2_NOM3_NOM4.zip+\end{center} \textbf{avant la date indiquée sur la zone de dépôt}. Chaque fichier supplémentaire ajouté dans le projet doit contenir en entête un \textbf{commentaire} comportant une description du fichier et l'ensemble de vos noms et prénoms. Inspirez-vous des sources fournies dans le projet. Vous pouvez également modifier le fichier \texttt{README} pour y décrire l'organisation de vos modules, les fonctionnalités et les changements apportés dans le projet ainsi que les limites rencontrées.
Vous allez pouvoir effectuer le rendu directement depuis l'interface de Gitlab, en réalisant ce qu'on appelle une **demande de fusion**.
Cela permet d'envoyer tous les changements que vous avez effectué aux propriétaires du dépôt Gitlab d'origine (donc nous !) en quelques clics.
0. Assurez vous d'avoir effectué tous les *commits* et *pushs* nécessaires avec git.
1. Dans le panneau de gauche, cliquez sur "Demandes de fusion".
2. Cliquez sur "Nouvelle demande de fusion".
3. Vérifiez que dans la partie droite on trouve bien `naomod/software-development-course/onlineChess` et `master`.
4. Dans la partie gauche, choisissez `<votre nom d'utilisateur>/onlineChess` (normalement déjà choisi) et également `master`.
5. Cliquez sur "Compare branches and continue".
6. Comme titre pour la demande de fusion, indiquez "Rendu NOM1 NOM2".
7. Enfin, cliquez en bas sur "Submit demande de fusion"
Vous atteignez alors une page qui résume la demande effectuée.
Nous vous recommandons alors de cliquer sur l'onglet "Changes" afin d'avoir accès une une représentation visuelle de tous les changements que vous avez effectué.
Les lignes rouges indiques ce que vous avez retiré, les lignes vertes indiquent ce que vous avez ajouté.
Vérifiez si tout votre rendu est bien présent sous la forme de lignes vertes.
Si vous le souhaitez, vous pouvez ajouter un fichier "`RENDU.md`" à la racine du projet, afin de décrire les spécificités de votre projet (choix techniques, parties non traitées, extensions non demandées, etc.).
### Derniers conseils
- Rappelez-vous que «Une fonction sans test unitaire ne fonctionne pas»!
- Rappelez-vous que « *Une fonction sans test unitaire ne fonctionne pas* »!
- Écrivez les tests unitaires avant ou en même temps que les fonctions. Ne les laissez pas pour la fin, les test unitaires sont très utiles pendant le développement et vous feront gagner du temps.
-
- Faites bon usage de `git`: effectuez des *commits* et des *pushs* régulièrement ! Cela vous permet d'éviter de perdre votre travail, et de mieux collaborer en équipe.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment