IQSS
Define Dataverse Frontend CHANGELOG strategy
Overview of the Feature Request We currently do not have a CHANGELOG for the Dataverse Frontend repository. We should define a process to create and maintain one, so that all changes are clearly documented and easy to review.
What kind of user is the feature intended for? Community
What inspired the request? Sprint planning discussion
What existing behavior do you want changed? N/A Any brand-new behavior do you want to add to Dataverse? N/A Any open or closed issues related to this feature request? None
We could try https://github.com/nedbat/scriv to automate what we do in the main repo manually with release note snippets.
I have a written doc for CHANGELOG strategy here, please check it out and leave your comments on it!
https://docs.google.com/document/d/1SFe3ffSJaH18pePc7cqIkMq_uzeSD6uGQe7YkQDy1FQ/edit?tab=t.0
Frontend Team – Changelog Discussion Updates (Sept 11, 2025, based on the draft Changelog process
- We will manually add entries to CHANGELOG.md.
- Merge conflicts will be handled as they come (no external tooling).
Purpose of the changelog
- It should capture all technical details needed to understand, and ensure the changelog is beneficial for development.
Content guidelines
- Include developer-relevant changes (features, bug fixes, breaking changes, behavior shifts).
- Issue numbers may be included if helpful, but are not mandatory.
Release notes distinction
- At release time, release notes could be generated from the changelog.
- Release notes are user-oriented → they will not include the full developer detail.
Next Step: https://github.com/IQSS/dataverse-frontend/issues/828