Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details in the Changelog #164

Open
lecoqlibre opened this issue Nov 27, 2024 · 1 comment
Open

Add details in the Changelog #164

lecoqlibre opened this issue Nov 27, 2024 · 1 comment

Comments

@lecoqlibre
Copy link
Member

The Changelog should be explaining what it has been done in a release. We should use sentences with verbs instead of / or in addition to just a list of words.

For instance we could use these little descriptions used in ou French report:

  • la v.1.8 : ajout des numéros de téléphones (nécessaires à la communication entre acteurs au moment de la livraison).
  • en v.1.9 : les informations de température (réfrigéré, congelé, ambiante), d’option de livraison et de méthodes de paiements, les informations sur l'emballage ou encore les contraintes de livraison ont fait leur entrée dans le protocole commun.
  • en v1.10 : Ajout des statuts de réalisation, de commandes, de paiement pour caractériser la commande durant son processus de l’achat à livraison.
  • en v1.11 : Ajout de la région pour décrire la géolocalisation.
  • en v1.12 : Ajout d’un lien pour décrire l’agent qui a réalisé une vente.
  • en v1.13 : Ajout des classes pour décrire plus précisément le poids, le volume et la longueur d’un produit.
  • en v1.14 : Ajout d’un lien pour lier une ligne de commande et le produit physique pour la logistique et la traçabilité, et des définitions des classes et des propriétés pour enrichir la description de l'ontologie.
@RachL
Copy link
Member

RachL commented Nov 27, 2024

if everything is linked to PR, you can add a description in the PR template that gets fetch by github when creating the changelog.

Some tools make it easier like https://github.com/orhun/git-cliff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

2 participants