Consignes aux développeurs

Vous souhaitez intégrer le projet Archity en tant que développeur? Vous ne savez pas comment faire? Vous trouverez sur cette page, toutes les informations nécessaires pour intégrer l'équipe des développeurs d'Archity.

_____________________________________________________________________________________________
Quel langage, quels outils?
Le projet Archity est codé en C++. Rien ne vous empêche alors d'utiliser l'IDE (environnement de développement intégré) de votre choix. En voici quelques-uns, gratuits: Code::Blocks, Dev-C++, Visual C++ Express Edition.
Si vous voulez travailler sur le même IDE que les initiateurs du projet, nous vous conseillons Code::Blocks
Nous supposerons ici que nous travaillons sous Windows, mais rien n'interdit a priori de travailler sur un autre OS. Si tel est le cas, indiquez sous quel OS vous travaillez aux responsables du projet.


_____________________________________________________________________________________________
Comment intégrer le projet en tant que développeur?
Pour cela vous devez créer un compte sur SourceForge si vous n'en possédez pas déjà un, cela ne prend que deux minutes.
Puis, il suffit alors de faire la demande auprès des administrateurs du projet: max54 ou manchou (uohcnam sur SourceForge) par MP sur TSC ou directement en les contactant via la page du projet Archity (sur SourceForge).


_____________________________________________________________________________________________
Et ensuite, que dois-je faire pour participer?
Le projet Archity possède un système de gestion de version, en l'occurrence SVN [wikipedia] [site officiel], ce qui permet à tous les membres du projet de partager leur travail en toute simplicité. Ainsi, lorsqu'un membre du projet effectuera une modification dans le code, tout les autres membres pourront récupérer ces modifications avant de travailler à leur tour sur le code. Voyons maintenant comment procéder...

ÉTAPE 1 : Votre premier travail va donc être de télécharger le logiciel qui va vous permettre de récupérer la dernière version disponible du code avant de pouvoir le modifier, mais qui vous permettra également de partager votre travail avec les autres membres, ce logiciel c'est Subversion (notre fameux SVN) : téléchargez-le ici et installez-le.
Remarque 1: Si vous travaillez sous Windows, faites attention à choisir la version qui convient selon votre processeur (32 ou 64 bits).
Remarque 2: Après avoir télécharger SVN, vous pouvez télécharger un logiciel utilitaire qui offre une interface graphique à SVN comme par exemple Tortoise SVN, mais nous ne détaillerons pas ici son utilisation, puisque nous travaillerons uniquement en lignes de commande par la suite.

ÉTAPE 2 : Nous allons maintenant récupérer les fichiers déjà présents dans le dépôt (repository en anglais). Alors, déjà commençons par voir ce qu'est le dépôt^^. Le dépôt c'est l'endroit où sont stockés tous les fichiers du projet sur un serveur distant (le dépôt d'Archity se situe ici). Vous allez donc devoir extraire les fichiers du dépôt pour en faire un copie sur votre disque dur: c'est la copie de travail. Lorsque vous travaillerez sur un fichier, vous modifierez votre copie de travail et nous verrons un peu plus tard comment l'envoyer dans le dépôt pour que les autres membres du projet puisse la récupérer (et donc récupérer les modifications que vous avez apportées au projet).
Voyons donc maintenant, comment récupérer les fichiers du dépôt! Tout d'abord, il vous faut créer un répertoire sur votre disque dur où se trouveront les fichiers de votre copie de travail (mettez ce répertoire où vous voulez, ça n'a aucune importance, pour l'exemple, nous créerons un dossier "Archity" directement sur le disque C:).
Cliquez sur le menu Démarrer, puis Exécuter (dans le menu Accessoires sous Vista et Seven). Et entrez "cmd".
La fenêtre de l'Invite de commandes de Windows apparaît, par défaut vous devriez vous trouvez dans votre répertoire "Mes documents" et donc voir quelque chose comme: "C:\Users\votre nom>". Vous devez alors vous placez dans le répertoire de travail que vous venez de créer précédemment (C:/Archity dans notre exemple). Pour cela, entre la commande suivante: cd "C:\Archity" puis appuyez sur Entrée, vérifiez que le début de la ligne qui apparaît indique bien l'emplacement où se trouvera votre copie de travail.
Remarque : Si votre copie de travail n'est pas C:/Archity, entrez l'adresse complète du répertoire de la copie de travail dans la commande indiquée ci-dessus à la place de C:/Archity. Vous pouvez également consulter l'aide de l'Invite de commande en tapant simplement help à tout moment dans l'Invite de commandes de Windows.

ÉTAPE 3 : Une fois placés dans le bon répertoire, celui de notre copie de travail, nous allons (enfin) pouvoir récupérer les fichiers du dépôt pour cela, il vous suffit d'entrer directement la commande suivante (commande CHECKOUT):
svn co https://archity.svn.sourceforge.net/svnroot/archity
Et voilà, le tour est joué! Vous allez enfin pouvoir travailler sur le code!
Remarque : Normalement, il s'agit de l'unique fois où vous entrerez cette commande.


_____________________________________________________________________________________________
Comment utiliser SVN?
Vous possédez maintenant la dernière version des fichiers du projet. Vous pouvez alors travailler dessus à partir de votre copie de travail.

Cependant, avant de commencer à travailler, et à chaque fois que vous voudrez travailler sur le projet, retournez dans l'Invite de commandes de Windows. Et placez vous dans le répertoire de votre copie de travail, entrez alors la commande suivante (commande UPDATE): svn up, elle vous permet de récupérer à tout instant la dernière version du projet.

Une fois que vous avez apporté des modifications au projet, vous devrez commettre vos modifications dans le dépôt, autrement dit envoyer les fichiers modifiés dans le dépôt en vous plaçant dans le répertoire de la copie de travail, toujours dans l'Invite de commandes de Windows, et en saisissant la commande suivante (commande COMMIT):
svn ci [fichiers] -m [message], en remplaçant [fichiers] par un point pour mettre à jour tous les fichiers que vous avez modifiés ou par la liste des fichiers à envoyer en séparant les fichiers par des espaces et vous devrez obligatoirement mettre un message descriptif assez bref, et en anglais, des modifications apportées, à la place de [message] et entre guillemets. N'oubliez surtout pas le message, faute de quoi, vous ne pourrez pas envoyer vos fichiers!
Remarque : Avant d'effectuer une commande COMMIT, je vous conseille d'effectuer une commande UPDATE juste avant .

Dernier point très important, si vous créez de nouveaux fichiers à ajouter au projet, vous devrez entrer la commande suivante (commande ADD) avant d'effectuer la commande COMMIT:
svn add [fichiers] en remplaçant [fichiers] par la liste des fichiers, séparés par des espaces, à ajouter au projet, et donc au dépôt.


_____________________________________________________________________________________________
Consignes sur la présentation des fichiers
Le projet Archity est sous licence GNU/GPLv3, et par conséquent, nous vous demandons de commencer chaque fichier par l'en-tête suivant:

/**
* Archity - A realistic and a most complete as possible city-builder.
* Copyright (C) 2011.
* Project website : http://sourceforge.net/projects/archity/
*
* ------------------------------------------------------
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
*
* ------------------------------------------------------
*
* [nom du fichier]
* Author(s): [votre nom]
* Date: [date de la dernière modification]
*/

La licence GNU/GPLv3 implique donc que le code et tous les composants constituant le projet Archity sont libres de droit [wikipedia]


_____________________________________________________________________________________________
Consignes de programmation
Afin d'être lisible par tous, et d'être relativement uniformisé, nous vous demandons de respecter ces quelques consignes de programmation:

- Commentez votre code EN ANGLAIS de manière simple et concise, afin que tout un chacun puisse comprendre ce que vous faites
- INDENTEZ votre code [wikipedia] et n'hésitez pas à l'aérer pour qu'il soit agréable à lire.


_____________________________________________________________________________________________
Conventions de nommage
Prochainement.

Téléchargez SC4 Region Maker!