9
votes

Marquer des messages commettrations et des modifications

Je recherche une solution, de tag Modifications des messages de validation.

pour moi une "tag" est quelque chose comme:

  • Code Nettoyer
  • Changement visible de l'utilisateur
  • modifie la structure de la base de données (Alter Table)
  • Documentation Change

    jusqu'à présent, j'utilise SVN, mais je veux passer à Git. S'il y aurait du standard, beaucoup d'outils comme Trac, Redmine, ... pourraient utiliser cela.

    Je veux que cela réponde à des questions comme ceci:

    • Si je mettez à jour un système, quels changements sont visibles pour le client, ou est-ce juste une mise à jour de maintenance?
    • a le schéma de base de données a changé entre deux versions?

      arrière-plan:

      jusqu'à présent, j'utilise l'unisson pour synchroniser entre Dev, Test et Prod System. Mais l'Unisson ne sait rien à propos de la gestion de la version (qui est SVN au moment des moments). Je veux passer à Git. Et je veux voir vite, quels sont les changements.

      Exemple: je veux voir des changements entre test et prod. Je ne veux pas voir les modifications du code source, mais les messages de validation. Mais parfois, il y a jusqu'à 100 commits. Ici, je veux un filtre, exclure les changements sans importance.


0 commentaires

3 Réponses :


11
votes

J'aime utiliser les balises suivantes: xxx

Cette balise est toujours la première chose dans le message de validation puis suivie d'une brève description et / ou de la question-identifiant de la question. système de suivi, s'il existe.

J'utilise ces étiquettes avec SVN et Git et les avons jusqu'ici très commodes.

Pour répondre à votre édition: C'est pourquoi j'aime ces étiquettes de validation. Il est immédiatement visible si le commit change le comportement ou non. Si votre système de base de données change régulièrement ou si ces changements ou très importants pour vous, vous pouvez introduire une balise pour cela.

J'aime aussi combiner ces tags dans un message commettre, le cas échéant. E.G., "Configuration de la DOC TEST DE TEST FOO".

avec une balise de DB supplémentaire pour la base de données, vous pouvez facilement suivre les modifications liées à la base de données.


4 commentaires

+1 pour la bonne réponse. Mais si je dois avoir plus d'informations sur le changement à l'aide de sa balise? par exemple. J'ai besoin de plus sur un défaut (son journaliste, sa criticité, ses étapes de reproduction, etc.) résolues dans une étiquette de corrective.


Ensuite, vous pouvez simplement ajouter toutes ces informations après la balise, par exemple, "Correction du problème FOO signalé par John Doe; ..."


Désolé, je ne comprends pas ce que vous entendez par ce dernier commentaire.


Le <-href="http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html" Rel="nofollow NOREFERRER"> NOBPY Development Workflow énumère certaines abréviations standard.



1
votes

Je préfère attribuer chaque jeu de modifications avec un problème dans mon problème de suivi. En utilisant des suiveurs de problèmes connus comme JIRA, il est possible de sélectionner le problème résolu dans un jeu de modifications. Après avoir sélectionné un problème, la description du problème est automatiquement placée dans le message du jeu de modifications. Ils peuvent être suivis à l'avenir et être signalé dans votre tracker d'émission.


5 commentaires

J'ai mis à jour la question. Les tags devraient répondre à des questions telles que ceci: "Si je mettez à jour un système, quels changements sont visibles pour le client, ou est-ce juste une mise à jour de maintenance?"


Comment gérez-vous les engagements qui ne sont pas connectés à un problème? E.G., si vous ajoutez ou corrigez une documentation ou un refacteur quelque chose?


@guettli: Toutes ces informations sont conservées dans votre problème. De plus, d'autres informations telles que celui demandaient la modification, la version du code source que ce changement appliqué, la première version dans laquelle ces changements concernés, ... sont conservées sur les problèmes sur le suivi de la question.


@Mort: En tant que pratique SCM (Software Configuration Management), chaque modification du système doit être effectuée en fonction d'un problème.


@Hsalimi: Je suis en désaccord. Pensez à la situation suivante: vous travaillez dans votre code et trouvez des commentaires en ligne contenant des erreurs d'orthographe, mais ne sont liées à aucun problème dans votre base de données de problèmes. Que fais-tu? Créer un problème pour une erreur d'orthographe pour pouvoir connecter le commit à un problème? Je voudrais simplement commettre la correction de l'orthographe d'orthographe à l'aide d'un message commet comme "Doc Fix orthographe". De cette façon, lors de la numérisation de l'historique de validation, on voit immédiatement qu'on ne doit pas avoir de plus près ce commettre ce commettre.



5
votes

la plupart du temps que j'utilise le système de balises de TYPO3: http: //wiki.typo3 .org / commitmessage_format_ (git)

Il utilise des balises dans les messages tels que ceci: [tag] message court Bien sûr, j'ai toujours abordé un numéro de numéro pour le suivi des émissions. Nous utilisons Jira afin qu'il devienne quelque chose comme ceci: [tag] jira-123 message court

TYPO3 Tags:

étiquettes possibles sont:

  • [fonctionnalité]: une nouvelle fonctionnalité (également de petits ajouts). Très probablement, ce sera une fonctionnalité ajoutée, mais elle pourrait également être supprimée. Cela ne peut se produire que dans la branche «Master» de V4, car aucune nouvelle fonctionnalité n'est autorisée dans les branches plus âgées. Des exceptions à cela doivent être discutées au cas par cas avec les gestionnaires de libération correspondants.
  • [bugfix]: une solution pour un bug.
  • [Tâche]: Tout ce qui n'est pas couvert par les catégories ci-dessus, par ex. Nettoyage de style de codage.
  • [API]: une API a changé, des méthodes ou des classes ont été ajoutées ou supprimées; Les signatures de méthode ou les types de retour ont changé. Cela fait seulement référence à l'API publique de TYPO3.

    plus d'autres drapeaux peuvent être ajoutés dans certaines circonstances:

    • [!!]: Changement de rupture. Après ce correctif, quelque chose fonctionne différemment qu'avant et le développeur utilisateur / administrateur / extension devra changer quelque chose. Devrait seulement arriver sur "maître".
    • [WIP]: Travailler en cours. Ce drapeau sera supprimé, une fois la version finale d'un changement disponible. Les changements marqués WIP ne sont jamais fusionnés.
    • [Sécurité]: visualise qu'un changement corrige un problème de sécurité. Cette balise est utilisée par l'équipe de sécurité, au cas où vous trouverez des problèmes de sécurité, veuillez toujours accepter d'entrer en contact avec l'équipe de sécurité d'abord!

      exemple de sujet descriptions de sujet:

      • [bugfix] jette httpstatusexceptions dans TSLIB_FE
      • [BUGFIX] [Security] Vulnérabilité d'injection SQL dans les déclarations préparées
      • [Feature] [Conf] Ajouter une option pour masquer Be Search Box dans la liste MOD
      • [!!!] [Feature] Déplacez l'édition avancée de frontage sur TER
      • [!!] [Tâche] Supprimer T3LIB_SQLENGINE
      • [!!] [API] Supprimer la méthode obsolète Redirection () de T3LIB_USERAUH
      • [API] Créez une hiérarchie d'exception pour les exceptions d'état HTTP

0 commentaires