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

Créer un changelog #87

Open
2 of 3 tasks
bchartier opened this issue Sep 30, 2024 · 7 comments
Open
2 of 3 tasks

Créer un changelog #87

bchartier opened this issue Sep 30, 2024 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@bchartier
Copy link
Collaborator

bchartier commented Sep 30, 2024

Créer un changelog :

  • Alimenter le fichier changelog.md avec un changelog complet
  • Ajouter un changelog résumé dans metadata.txt
  • Mettre à jour la date de la version 1.0.0 lors de sa publication

S'inspirer de ces initiatives :

@bchartier bchartier added the documentation Improvements or additions to documentation label Sep 30, 2024
@bchartier bchartier added this to the Stable release milestone Sep 30, 2024
@jbdesbas
Copy link
Member

jbdesbas commented Oct 1, 2024

Aujourd'hui c'est le metadata.txt destiné au dépôt qgis qui fait plus ou moins office de changelog.
https://github.com/geo2france/idg-qgis-plugin/blob/main/plugin/idg/metadata.txt

@bchartier bchartier self-assigned this Jan 6, 2025
@bchartier
Copy link
Collaborator Author

Discussion d'aujourd'hui avec @jbdesbas :

  • on fait un changelog détaillé pour Github
  • on maintient un changelog succinct dans le metadata.txt (une phrase par version indiquant la nature des modifs)

@bchartier
Copy link
Collaborator Author

Changelog complet :
https://github.com/geo2france/idg-qgis-plugin/blob/readme-update/CHANGELOG.md

Changelog résumé :
https://github.com/geo2france/idg-qgis-plugin/blob/readme-update/plugin/idg/metadata.txt#L28

Est-ce que ça vous paraît suffisamment complet et compréhensible ?

@bchartier
Copy link
Collaborator Author

Il restera à mettre la bonne date dans le changelog de la version 1.0.0.

@jbdesbas
Copy link
Member

jbdesbas commented Jan 8, 2025

Ca me va 👍 , au détail près qu'on pourrait mettre en premier les évolutions les plus visibles pour l'utilisateur sur le changelog résumé :
1.0.0 - Amélioration des performances ; meilleure intégration à QGIS ; réorganisation de l'arborescence des fichiers téléchargés ; Ajout de GeoPaysdeBrest ->
1.0.0 - Ajout de GeoPaysdeBrest; meilleure intégration à QGIS ; Amélioration des performances ; réorganisation de l'arborescence des fichiers téléchargés ;

@bchartier
Copy link
Collaborator Author

Ok, j'ai procédé à quelques changements.

@bchartier
Copy link
Collaborator Author

D'abord les features, ensuite les bugs et en dernier les optimisations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants