Participer au développement de Templeet

Vous souhaitez participer au développement de Templeet. Nous n'avons pas seulement besoin de développeurs, mais aussi de graphistes, de designers web, de rédacteurs pour des pages de documentation ou de tutoriaux, de rapporteur de bugs, de testeurs, et simplement de personnes qui ont des idées...

Proposez votre temps sur la liste utilisateur, nous trouverons quelque chose par rapport à vos envies et vos compétences.

Votre collaboration au wiki de documentation serait grandement appréciée.

Si vous souhaitez contribuer à Templeet en tant que développeur, la première étape consiste à télécharger son code source. Il est important de noter que ce code ne fonctionnera pas tel quel, et qu'il est obligatoire de passer par l'installeur pour installer Templeet en tant qu'utilisateur.

Si vous souhaitez que vos contributions soient facilement prises en compte (sans forcément être incluses), la méthode la plus simple pour vous comme pour nous est d'envoyer des patchs par rapport au CVS. Pour de la documentation sur l'utilisation de CVS, nous vous invitons à lire ce document rédigé par Alain Lesné et Olivier Berger.

Nous vous conseillons la procédure suivante pour vos développements :

1. Créer un fichier .cvsrc dans votre répertoire principal:
   

   diff -u
   update -d
   

2. Télécharger par CVS le source code de Templeet, et être sûr qu'il soit à jour.
3. Télécharger une version snapshot de l'installeur et installer Templeet sur votre serveur web, dans un répertoire de test.
4. Modifier directement les fichiers exportés par votre serveur web pour tester en temps réel vos modifications. Une fois votre développement terminé, copier les fichiers modifiés dans l'arborescence CVS.
5. Utiliser la commande cvs diff pour générer le patch, l'envoyer sur la liste développeur, s'il est conséquent l'envoyer sur la liste cvs.

Information sur l'accès CVS

Pour télécharger le code par CVS (anonyme) :

 > $ unset CVS_RSH
 > $ export CVSROOT=':pserver:anoncvs@cvs.templeet.org:/cvs'
 > $ cvs login
(mot de passe: anoncvs), puis :

 > $ cvs -z3 co templeet

Pour télécharger le code par CVS (identifié) :

 > $ export CVS_RSH=ssh
 > $ export CVSROOT=':pserver:LOGIN@cvs.templeet.org:/cvs'
 > $ cvs -z3 co templeet

Génération d'un patch

La meilleure façon de soumettre des morceaux de code pour Templeet, c'est de créer des patchs. Pour cela, vous aurez besoin d'utiliser diff (toujours avec l'option -u). C'est très facile à utiliser quand vous avez un accès CVS. Vous n'avez qu'à taper :

     cvs diff -u > ~/templeet.patch

Pour ajouter un nouveau fichier à votre patch, tapez ceci :

     diff -u /dev/null monfichier >> ~/templeet.patch 

Si vous n'avez pas accès à CVS, c'est un peu moins trivial. Vous aurez besoin d'installer Templeet à partir du même installeur dans deux répertoires différents. Nommez le premier Templeet.orig et le second Templeet. Faites ensuite l'intégralité de vos modifications dans le répertoire nommé Templeet, et aucune dans celui nommé Templeet.orig. Quand vous aurez terminé, tapez :

     diff -ur -I "^[-# *]*\$Id[:,_.+/a-zA-Z0-9 -]*\$$" --exclude CVS Templeet.orig Templeet > ~/templeet.patch

Pour ajouter de nouveaux fichiers à votre patch :

diff -uNr --exclude CVS Templeet.orig Templeet >> ~/templeet.patch 

Syntaxe du code source

Parce que Templeet intégre du code source provenant de différents contributeurs, il est important qu'une syntaxe commune soit utilisée, et quelques règles sont à suivre. Nous vous invitons à tenter de les appliquer aux patchs que vous proposerez. Voici une liste non-exhaustive :

1. N'utilisez pas d'espaces pour indenter votre code, mais des tabulations. Les seules exceptions sont les fichiers qui ne concernent pas du code pur tels que, par exemple, le fichier ChangeLog, NEWS, CREDITS, etc.
2. Tout le monde n'utilise pas des terminaux en 1600x1200, respectez une longueur maximale de 80 caractères par lignes. ':set tw=80' devrait convenir pour Vim.

Fichiers spéciaux

Il existe quelques fichiers spéciaux dans le CVS, voici leur usage :

• ChangeLog : liste toutes les modifications et les commits dans le CVS. Il apparaît qu'il n'est pas toujours à jour.
• CREDITS : liste les contributeurs à Templeet
• NEWS : liste les nouveautés apporté à Templeet
• SITES : listes des sites qui utilisent Templeet
• TODO : liste les différentes choses à faire dans Templeet