Revues de code permanente

[Klaim]

Bonjour, je ne retrouve pas le forum dédié aux propositions concernant le site donc je le poste ici comme ça concerne tous ceux qui sont dans le code. (la "bibliothèque" peut très bien se résumer a un fichier avec peu de code dedans, peu importe tant qu'on peut faire une revue du dit code)

Il y a de plus en plus d'outils de revue de code en ligne en ce moment, et je me disais que ça serait un service interessant pour la communauté developpez.com, notemment coté C++ ou les gens sont quand même assez pointus et (à force) se connaissent un peu, donc apportants chacun un gout différent et toujours interessant dans leur points de vue. (fin des compliments)

Donc en gros, un outil de revue de code sur developpez.net serait à mon avis très interessant. L'idée est simplement de "soumettre" une bibliothèque de code précis (une version précise, voir plus loin) dans l'outil qui permettrait alors à ceux qui le veulent de :

1. mettre des commentaires sur des bouts de code précis (ajouter des méta commentaires en fait, pas dans le code lui meme, mais gérés à part - voir comment marche google code par exemple)
2. faire un ou plusieurs commentaires globaux sur le code (en gros un peu comme un systeme de forum simplifié ou carément un sous forum dédié au code en question, ou au projet)
3. proposer des changements

Pour acomplir tout ça, il y a plusieurs choses a savoir :
1. est déjà possible sur github.com ou google code, donc ce sont de bons examples - ou alors faut voir si ya pas déjà des outils qui permettent de faire ça de manière agnostique (sans être lié a un hebergeur)
2. suffit d'un systeme de sous forums
3. pour les propositions de changements, l'outil permettrait de changer le code directement sur la page et de l'enregistrer sous forme de patch. OU BIEN de proposer de générer un fork/clone de la version du code en question.

Tout cela suppose que l'outil prends en entrée :
- soit un pack de fichiers contenant tout le code a faire revoir
- soit l'adresse à un repository publique (ou simplement accesible online avec mot de passe) en précisant la revision/version/tag à exposer comme étant "à faire voir"

A partir de là, l'outil extrait les sources, les expose sur une page web qui permet donc d'explorere les sources, d'ajouter des commentaires directement dans le code (1.), d'ajouter des commentaires dans des discussions liées (2.), de commencer a faire des proposiotions des modifications (3.).

J'espère qu'un outil existe déjà pour faire ça, dans le doute je vous expose d'abord ce que je penserai être plus efficace qu'un simple thread.

Note : le fait que l'outil prenne en entrée soit du code soit une addresse de repo est très important : cela permet eventuellement de demander a l'outil de repermettre la code review avec du nouveau code juste en changeant la version du code après modifications.

Voilà, je viens de vous balancez les idées un peu en vrac. Qu'en pensez-vous?

[Marc Lussac]

Je peu me tromper mais c'est un peu ce qu'on voulais faire avec un nouvel outil qu'on viens de mettre à disposition, mais qui n'a été mis en ligne encore que sur très peu de rubriques, voici un exemple sur la rubrique Qt : http://qt.developpez.com/telecharger/

Cet outil peu servir pour les codes mais aussi pour tous les téléchargements en général, donc aussi les outils et autres logiciels.
Note que cet outil est lié à des sujets forum pour les commentaires, même si dans la pratique il y en à pas encore car l'outil n'est pas encore assez connu.

Personnellement je n'en suis pas entièrement satisfait j'ai des améliorations à demander avant de pousser à une utilisation générale sur tous le site, mais c'est peut être une bonne base de départ.

Peut tu regarder cet outil et nous donner ton avis, à savoir :
- ce qui est bien ou pas bien
- ce qu'il manque ou ce qu'il faut améliorer

[Klaim]

Comme j'ai indiqué dans une autre discussion en rapport, pour moi ce service n'est pas complet parcequ'il ne permet pas d'avoir un clone de repository pour le dit code, pour permettre d'avoir l'evolution du code.

Une fois cela en place, effectivement le systeme de revue de code viendrait se reposer dessus, le compléter.

[Marc Lussac]

Pour les fonctionnalités type forge on à un autre service dans ce cas, le service projets (Powered by Redmine).

[Klaim]

Oui je suis au courant. En revanche il ne fournis pas de fonctionalité de revue de code (du mions pas sans plugin et je ne connais pas les dits plugins).

Pour moi, si un outil de revue de code accepte une url quelquonque pour accéder au code a faire revoir, il sera suffisamment isolé pour pouvoir marcher en combinaison avec n'importe quel autre outil ou support qui contient du code (bugtracker lié a un repo, un repo accessible, un fichier zip avec du code, un fichier unique avec du code, une url qui génère dynamiquement du code, etc.)

Dans cette optique, on évite les collisions de fonctionalités entre les outils, tout en optimisant chaque outil pour son propre role.

[dourouc05]

Envoyé par Klaim

Oui je suis au courant. En revanche il ne fournis pas de fonctionalité de revue de code (du mions pas sans plugin et je ne connais pas les dits plugins).

Il est possible d'installer les plug-ins nécessaires pour ajouter cette fonctionnalité. Sans faire de recherche approfondie, j'ai trouvé celui-ci : http://www.redmine.org/boards/3/topics/9627. On peut mettre des commentaires sur chaque commit. Maintenant, il est possible d'installer une application spécifique pour ça, mais je ne suis pas très chaud, du moins tant que le besoin ne se fait pas trop ressentir, tant qu'un plug-in dans Redmine pourrait convenir.

Ce que tu demandes peut se satisfaire de l'actuel, AMHA :
- soit c'est petit et il est possible de tenir dans le topic du téléchargement dans l'application suscitée ;
- soit c'est plus gros et ça mérite d'être hébergé comme projet.

[Klaim]

Dans le cas de peu de code, dans la rubrique téléchargement, je ne vois pas comment un plugin redmine peut aider?

[dourouc05]

Moi non plus. Dans ce cas, tu resteras dans le topic du sujet, donc tout le monde pourra discuter des quelques lignes présentées, pas besoin d'outil spécialisé dans ce cas.

[Klaim]

D'accord, mais c'est dommage parcequ'un bloc de text est moins efficace que bulles de commentaires par dessus du code (entre autre). Je pense particulièrement aux étudiants qui n'osent pas poser leur code ici parcequ'ils veulent juste avoir une revue et pas forcément avoir leur code dispo comme si c'était quelque chose de final (parceque le service de téléchargement suppose que le code peut être utile a quelqu'un d'autre non?).

Donc je vois bien que l'effort pourrait ne pas valoir le cout, mais je vois toujours l'utilité d'avoir un outil séparé.

Dommage que je n'en connaisse aucun déjà pret...

[dourouc05]

Dommage que je n'en connaisse aucun déjà pret...

Il y a ceci, par exemple : http://demo.reviewboard.org/r/. Le problème étant aussi que les discussions sont sur cette application, pas sur le forum, alors que 90 % (à la grosse louche) des utilisateurs ne connaissent que le forum, pas le reste ; ils risquent donc de ne pas trouver ces discussions qui risquent d'être très intéressantes.

parceque le service de téléchargement suppose que le code peut être utile a quelqu'un d'autre non?

Si le code n'était pas utile, il serait inutile de le proposer... Il y a aussi la possibilité de continuer la revue de code dans un topic à part de cette application. Il faut alors trouver un emplacement pour ce genre de topics ; je dirais quelque part dans Contribuez, à voir avec les resps C++ ce qu'ils peuvent envisager à ce niveau.

[Klaim]

Ce que je voulais dire par là, c'est qu'un code a revoir n'a pas forcément but d'être proposé a tout le monde, juste a faire voir. Notemment lorsqu'il sagit d'experimentations ou de bouts de code produits par des étudiants tentant d'implémenter un concept pour bien le comprendre.

Sinon j'ai déjà vu l'outil que tu pointes mais il ne corresponds pas à mes critères (qui peuvent evidemment être discutés).

En tout cas je retiens l'idée pour que je l'implemente moi mêem si dans 2 3 ans ça n'est pas déjà fait.

[dourouc05]

Envoyé par Klaim

Notamment lorsqu'il sagit d'experimentations ou de bouts de code produits par des étudiants tentant d'implémenter un concept pour bien le comprendre.

Pour ça, il y a le forum Débuter, c'est d'ailleurs une saine utilisation du forum Débuter - on essaye d'y aider les débutants, pas de leur fournir une solution clé-en-main, car cela n'apprend rien.

[Klaim]

Oui mais c'est un forum. Ce que je veux dire c'est que c'est bien pour une discussion globale (point 2) mais pas pour les autres pratiques lors d'une revue de code.

C'est bien mais pas suffisant a mon humble avis.

Mais c'est vrai que ça peut paraitre overkill.