Développement
Un article de Mille-Xterm.
Si vous désirez devenir membre du développement, vous pouvez contacter un des gestionnaire du projet afin d'obtenir les droits d'accès requis. Par la suite vous pouvez lire le contrat d’équipe qui vous permettra de connaître les méthodes, le but, la vision, la définition des rôles, les responsabilités et de normaliser les règles de fonctionnement interne.
La majorité de la documentation du projet est écrit en anglais, afin qu'il soit lisible par la communauté du logiciel libre.
Sommaire |
Participation au projet
Si vous désirez participer au développement, vous pouvez contacter un des gestionnaires du projet afin d'obtenir les droits d'accès requis.
Par la suite vous pouvez lire le contrat d’équipe qui vous permettra de connaître les méthodes, le but, la vision, la définition des rôles, les responsabilités et de normaliser les règles de fonctionnement interne.
Développeurs principaux
Le développement se fait actuellement avec les partenaires suivants :
- CRIM (Centre de recherche informatique de Montréal)
- Révolution Linux
- Membres du projets MILLE
- Toute autres personnes qui désirent participer
Inscription aux listes d'envois
Si vous désirez participer aux discutions ou obtenir de l'aide concernant Mille-Xterm, vous pouvez vous inscrire à l'adresse suivante :
http://lists.sourceforge.net/lists/listinfo/mille-xterm-devel
Si vous désirez recevoir de l'information sur les modifications récentes apportées à la version de développement, vous pouvez vous inscrire à l'adresse suivante :
http://lists.sourceforge.net/lists/listinfo/mille-xterm-svn-commit
Les discutions sont principalement en anglais, afin qu'elles soientt lisible par la communauté du logiciel libre
Système de gestion des versions de développement
Le système de gestion des versions utilisé est Subversion (SVN) et vous trouverez le site de développement à l'adresse suivante : http://svn.revolutionlinux.com/MILLE/XTERM
Pour une obtenir des droits d'accès, veuillez contacter un des dirigeants du projet.
Le projet se trouve aussi sous SourceForce qui sert principalement à gérer le projet, conserver l'historique des listes de discussions et un moyen de publication du logiciel.
Téléchargement des sources de Mille-Xterm
Vous pouvez télécharger les fichiers sources de Mille-Xterm l'aide de la procédure suivante :
Téléchargement des sources de développement via SVN
Génération des paquetages à partir des sources
Pour générer les paquetages à partir des sources de Mille-Xterm Génération des paquetages de Mille-Xterm à partir des sources.
Modifier un fichier de la version de développement
- Mettre à jour les sources téléchargées afin de s'assurer de ne pas écraser des fichiers modifiés par un autre développeur. Vous pouvez utiliser la commande suivante à partir du répertoire à mettre à jour:
svn update - À partir des fichiers téléchargés via SVN, effectuer les modifications dans le fichier désiré.
- Se positionner dans le répertoire du fichier modifié et exécuter la commande suivante :
svn commit NOM_DU_FICHIER -m "Commentaires décrivant la modification"
Guide de développement
Le guide de développement se trouve à la page suivante : Guide de développement
Règles importantes
Voici quelques règles importantes à suivre :
- Il ne faut pas commiter des fichiers générés, comme les binaires et les paquets. Ceux-ci doivent toujours être regénérés au besoin, et ils est donc inutile de les placer dans Subversion.
- Tous les fichiers doivent avoir la propriété svn:keywords $Id$ pour permettre de retracer à l'intérieur du fichier, les informations de révision.
- Commitez souvent dans une journée. Il sera plus facile de travailler en équipe si chacun propage ses changements rapidement.
- Testez votre code avant de commiter. S'il comporte des bugs connus, au moins il ne doit pas provoquer d'erreur fatale. Utilisez des instructions "try except" dans votre code pour absorber les erreurs.
- Si votre code est vraiment un trop gros changement, il faut alors créer une branche à part. Contactez le responsable de la publication pour effectuer cette opération si vous ne savez pas comment.
- Commentez amplement le code que vous ajoutez et utilisez la langue anglaise.
Langages de programmation utilisé
Tout le code devra être écrit en Python, sauf quelques exceptions :
- Le configurateur est en PHP
- Certains scripts sont en Shell
- Les filtres des imprimantes sont en C++
Vous devez avoir une bonne raison pour ne pas utiliser Python
Si vous désirez apprendre le python, vous pouvez consulter l'excellent livre : How to Think Like a Computer Scientist : Learning with Python
Nomenclature des noms de fichiers
- Tous les fichiers et les répertoires doivent être en minuscules, à l'exception de ceux qui se trouvent à la racine du dépôt. Par exemple, les fichiers README et INSTALL.
- Donnez des noms significatifs aux fichiers tout en essayant qu'ils soient les plus courts possible.
- Le nom "mille-xterm" est le nom du programme principal. Toutes les fonctions reliées à mille-xterm doivent commencer par ce nom suivies d'un tiret et du nom de la composante à la quelle il est relié.
Par exemple : mille-xterm-appserver
Nomenclature des fichiers sources
- La nomenclature des fonctions comportant des noms longs doit être comme-ceci :
def fonction_une_telle(self):
- La nomenclature des classes comportant des noms longs doit être comme-ceci :
class ClassUneTelle:
De cette manière, il est facile de les différencier...
Entête des fichiers sources
Les fichiers sources, créés par les participants au projet, possèdent une entête similaire à ceci :
# Copyright (Année de création du fichier), Mille-Xterm, (Nom de l'auteur) # # This file is part of the MILLE-XTERM distribution. # See the MILLE-XTERM web site at : # http://www.mille-xterm.org/ # # See the MILLE project web site at : # http://www.mille.ca/ # # The MILLE-XTERM framework is covered by the GNU General Public License. See # the COPYING file in the top-level MILLE-XTERM directory. Software packages # that are included in the MILLE-XTERM distribution have their own licenses. # # -------------------------------------------------------------------------
