English

Quelques règles à respecter sur ce dépôt

Licence

Pour une question légale, chaque plugin ou thème déposé sur le lab doit être distribué sous une licence valide :

• pour un plugin, vous devez choicir une licence libre compatible avec celle de Dotlcear :  GNU GPL (Generic Public License) version 2,  GNU GPL version 3,  AGPL version 2 or 3.
• pour un thème, vous pouvez choisir entre différentes licences :  CC,  GNU GPL (Generic Public License) version 2,  BSD, etc...

Chaque fichier doit comporter dans son en-tête un bloc de licence correspondant à celle que vous avez choisi. Par exemple, avec la licence GNU GPL V2 :

# -- BEGIN LICENSE BLOCK ----------------------------------
# This file is part of <nom du plugin>, a plugin for Dotclear.
# 
# Copyright (c) <année> <prénom nom>
# <adresse email>
# 
# Licensed under the GPL version 2.0 license.
# A copy of this license is available in LICENSE file or at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# -- END LICENSE BLOCK ------------------------------------

Il existe cependant quelques exceptions :

• Les fichiers *.js ainsi que *.css peuvent être chargés sur le blog coté public. C'est pourquoi, vous n'êtes pas obligé de mettre un bloc de licences dans leurs en-têtes pour ne pas surcharger les pages publiques.
• Les fichiers *.html peuvent avoir un bloc de licence dans leurs en-têtes mais il n'est pas recommandé d'un mettre un.

Convention de codage

Nous essayons d'améliorer la qualité des créations présentes ici. C'est pourquoi nous demandons aux auteurs un petit effort et de jouer le jeu afin de respecter les standards. Si jamais cela n'était pas le cas, les administrateurs vous le rappelleront par email.

Pour les plugins, nous recommandons aux auteurs de "minifier" les fichiers *.css et *.js. Pour les thèmes, nous recommandons aux auteurs de "minifier" seulement les fichiers *.js. Pour cela, vous pouvez utiliser  l'excellent script minify ou plus simplement le plugin webOptimizer (merci peck).

Plugins

Merci de  lire cette section de la documentation de Dotclear sur comment configurer correctement votre installation php et surtout le respect des règles de codage de Dotclear. Merci aussi de  lire cette section à propos de la structure de fichiers d'un plugin Dotclear. Il est très important de respecter les noms de fichiers.

Thèmes

Dans le but de faire des thèmes Dotclear standards, merci de suivre attentivement  cette section qui décrit la structure HTML qu'un thème doit utilisé ainsi que  cette section sur la structure de fichiers d'un thème

Collaboration

Les fichiers déposés dans ce dépôt peuvent être modifiés par tous les membres dans le but de les améliorer. Vous comprenez donc que votre création est susceptible d'être modifié et que vous êtes encouragés à faire de même.

Cependant, si vous souhaitez intervenir sur un plugin que vous ne gérez pas, il est vivement conseillé d'en notifier d'abord l'auteur principal afin d'aboutir à un accord.

Rappelez-vous que si un conflit venait à se présenter, la gestion des versions SVN vous permet toujours de revenir en arrière et en cas de problème, n'hésitez pas à contacter les administrateurs.