[SPIP Zone] Organisation du plugin Codeur d'email

Bonjour,

En regardant sur le site Plugins SPIP dont nous nous occupons avec Brunon nous sommes tombés sur quelques soucis avec ton plugin.

En premier lieu il n’avait pas de catégorie, le lien de documentation était dans le texte alors qu’un tag est prévu pour cela… J’ai voulu en rajouter et là je suis tombé sur l’organisation des répertoires qui ne correspond pas à ce qu’on demande sur la zone et qui posera surement à terme des confusions pour les utilisateurs et développeurs.

Ton organisation décrite dans les règles de commit est :

  • rspip2_code_mail (SPIP 2.1)

  • rspip3_code_mail (SPIP 3.0)

  • Ensuite, dans chacun des rspipX_code_mail
    rspipX_code_mail > trunk Actuellement, c’est là qu’on développe.
    rspipX_code_mail > tag > X.X.X Ce sont les versions stables, lockées pour interdire les commit

  • Si necessaire, des branche X.X seront créées avec la structure suivante:
    rspipX_code_mail > branch > X.X

En outre, suivant la version spip 2 ou 3 tu dupliques le numéro de version ce qui se traduit par deux paquets avec le même numéro de version ce que nous évitons absolument. En outre, tu as pléthore de tags et branches et il n’est plus vraiment facile d’identifier ce qu’il faut modifier ou pas.

C’est pourquoi nous te proposons de changer ton organisation de la manière suivante et de s’en occuper :

  • rspip_code_mail/ est la racine de ton plugin

En dessous on crée comme pour la plupart des plugins les sous-répertoires :

  • trunk/

  • branches/

(en général on met les tags dans le root/tags/ plutôt que dans les plugins mais en fait on commence à ne plus utiliser les tags qui sont non modifiables au profit des branches).

En dessous de branches/ on aurait :

  • v1/ qui correspond à la version du plugin pour SPIP 2. Aujourd’hui tu as l’air d’en être à la version 1.1.0 de cette branche. Par exemple, je devrais faire mes modifications dont j’ai parlé plus haut dans le plugin.xml et passer en version 1.1.1 ce qu’aujourd’hui je ne sais pas où faire. En outre, je pense qu’il faut zipper cette branche afin que les corrections soient prises en compte immédiatement sans créer un nouveau tag pour cela.

On pourrait aussi créer une branche v2/ pour SPIP 3 mais seulement si cela a un intérêt aujourd’hui, cad si tu utiliserais le trunk pour faire des essais de dev sur SPIP 3.1 par exemple. Donc aujourd’hui je m’en passerais.

En dessous de trunk/ on a la dernière version en cours qui serait donc celle pour SPIP 3. C’est cella-là qu’on zipperais aussi et dans laquelle je ferais mes modifications du paquet.xml. La seule interrogation que j’ai concerne la branche SPIP 3 appelé 1.2.0.

En outre, il faut renommer la version pour SPIP 3 en V2.0.0 afin d’évoluer séparément de celle pour SPIP 2.

Si tu es ok, on fera les modifications avec Bruno et tout rentrera dans l’ordre sur Plugins SPIP.

++

Eric

Ah, je suis pas le seul à avoir du mal à me faire à l'organisation
courante ^^ (mais c'est encore différent de celle de Robert)

Yop,

Bonjour Eric,

merci pour tes remarques. Il me semble en effet que je peux améliorer
l'organisation du plugin, surtout si d'autre voulaient éventuellement y
participer. (bien que le plugin avait déjà été réorganisé au départ,
voir cette discussion dans l'espace privé de spip contrib
<SPIP-Contrib)

Cependant, je préfère examiner calmement vos propositions avant d'agir.
Je préfère également le faire moi-même, car je souhaite maitriser cette
organisation et être sûr qu'il n'y a pas de subtilités oubliées,
d'incohérence, etc.

Pour le moment, mon travail alimentaire me surcharge complètement
jusqu'à fin juin très probablement. C'est donc début juillet que je
réexaminerai les choses, en tenant compte de vos remarques.

Encore merci, et à bientôt,
Robert.

-------- Message original --------
Sujet: Organisation du plugin Codeur d'email
De : Eric <eric@smellup.net>
Pour : SPIP-Zone <spip-zone@rezo.net>, robert.sebille@cassiopea.org
Copie à : Bruno Bergot <brunobergot@gmail.com>
Date : 1/05/13 14:26

Bonjour,

En regardant sur le site Plugins SPIP dont nous nous occupons avec Brunon
nous sommes tombés sur quelques soucis avec ton plugin.

En premier lieu il n'avait pas de catégorie, le lien de documentation était
dans le texte alors qu'un tag est prévu pour cela... J'ai voulu en rajouter
et là je suis tombé sur l'organisation des répertoires qui ne correspond
pas à ce qu'on demande sur la zone et qui posera surement à terme des
confusions pour les utilisateurs et développeurs.

Ton organisation décrite dans les règles de commit est :

- rspip2_code_mail (SPIP 2.1)
- rspip3_code_mail (SPIP 3.0)

- Ensuite, dans chacun des rspipX_code_mail
rspipX_code_mail > trunk Actuellement, c'est là qu'on développe.
rspipX_code_mail > tag > X.X.X Ce sont les versions stables, lockées pour
interdire les commit

- Si necessaire, des branche X.X seront créées avec la structure suivante:
rspipX_code_mail > branch > X.X

En outre, suivant la version spip 2 ou 3 tu dupliques le numéro de version
ce qui se traduit par deux paquets avec le même numéro de version ce que
nous évitons absolument. En outre, tu as pléthore de tags et branches et il
n'est plus vraiment facile d'identifier ce qu'il faut modifier ou pas.

C'est pourquoi nous te proposons de changer ton organisation de la manière
suivante et de s'en occuper :

- rspip_code_mail/ est la racine de ton plugin

En dessous on crée comme pour la plupart des plugins les sous-répertoires :
- trunk/
- branches/
(en général on met les tags dans le root/tags/ plutôt que dans les plugins
mais en fait on commence à ne plus utiliser les tags qui sont non
modifiables au profit des branches).

En dessous de branches/ on aurait :
- v1/ qui correspond à la version du plugin pour SPIP 2. Aujourd'hui tu as
l'air d'en être à la version 1.1.0 de cette branche. Par exemple, je
devrais faire mes modifications dont j'ai parlé plus haut dans le
plugin.xml et passer en version 1.1.1 ce qu'aujourd'hui je ne sais pas où
faire. En outre, je pense qu'il faut zipper cette branche afin que les
corrections soient prises en compte immédiatement sans créer un nouveau tag
pour cela.

On pourrait aussi créer une branche v2/ pour SPIP 3 mais seulement si cela
a un intérêt aujourd'hui, cad si tu utiliserais le trunk pour faire des
essais de dev sur SPIP 3.1 par exemple. Donc aujourd'hui je m'en passerais.

En dessous de trunk/ on a la dernière version en cours qui serait donc
celle pour SPIP 3. C'est cella-là qu'on zipperais aussi et dans laquelle je
ferais mes modifications du paquet.xml. La seule interrogation que j'ai
concerne la branche SPIP 3 appelé 1.2.0.
En outre, il faut renommer la version pour SPIP 3 en V2.0.0 afin d'évoluer
séparément de celle pour SPIP 2.

Si tu es ok, on fera les modifications avec Bruno et tout rentrera dans
l'ordre sur Plugins SPIP.

++
Eric

Bonjour Robert,

Bonjour Eric,

merci pour tes remarques. Il me semble en effet que je peux améliorer
l'organisation du plugin, surtout si d'autre voulaient éventuellement y
participer. (bien que le plugin avait déjà été réorganisé au départ,
voir cette discussion dans l'espace privé de spip contrib
<SPIP-Contrib)

D'après cette discussion, Maïeul a dit la même chose que Éric. Sauf
qu'il s'est contenté du fait que tu as ré-organisé de façon à ce qu'on
puisse créer les archives même si ce n'était pas suffisant (par
rapport à cela Éric a explicité le pourquoi du comment)

Cependant, je préfère examiner calmement vos propositions avant d'agir.
Je préfère également le faire moi-même, car je souhaite maitriser cette
organisation et être sûr qu'il n'y a pas de subtilités oubliées,
d'incohérence, etc.

L'idée de base est d'avoir un répertoire par projet (en fait plugin
toutes versions confondues) Est-ce que cela semble trop difficile à
comprendre ?

Si on est d'accord sur le premier point, la seconde idée directrice de
l'organisation de La Zone est d'avoir dans ce répertoire un
sous-répertoire par version. Si on met de côté le fait que ces
sous-répertoires sont, par convention, dans /branches ; est-ce que
cela est difficile à comprendre et à maitriser ?

Pour le moment, mon travail alimentaire me surcharge complètement
jusqu'à fin juin très probablement. C'est donc début juillet que je
réexaminerai les choses, en tenant compte de vos remarques.

Franchement la chose ne prend même pas cinq minutes ! Et il a été
proposé gracieusement de le faire pour toi justement si t'es débordé.
Alors un peu de bonne volonté...

Hello,