Conversation
ekraffmiller
left a comment
There was a problem hiding this comment.
A general question, I think in our meeting we decided that each PR would have a corresponding update to the Changelog? If so, we could make the documentation more clear about that.
|
@ekraffmiller sorry, I didn't update it to my draft so forgot this. I add a folder named releases-note to collect the changelog fragments, which is similar to what we did in dataverse repo. Thanks for reviewing |
.github/CONTRIBUTING.md
Outdated
|
|
||
| We maintain separate changelogs for different components: | ||
|
|
||
| - **Main application changes**: Create fragments in [`docs/release-notes/`](../docs/release-notes/) |
There was a problem hiding this comment.
In our meeting I think we discussed updating the CHANGELOG.md directly, rather than creating individual fragments for each PR. We discussed how there would be merge conflicts but they would be relatively straightforward to resolve. Unless I am misremembering?
There was a problem hiding this comment.
Ohh, I see—I misunderstood. I thought the part about merge conflicts was explaining why we don’t need an automation tool, and I also thought you were referring to me missing the fragment part last comment. Sorry about that! But it makes sense now, and I can change it back.
ekraffmiller
left a comment
There was a problem hiding this comment.
looks good, approved!
What this PR does / why we need it:
Based on Changelog Strategy doc, and #804 , we discussed on the frontend meeting Sep11th 2025, we decide to move forward and create an issue to add CHANGELOG to the front repo.
Which issue(s) this PR closes:
Special notes for your reviewer:
Suggestions on how to test this:
Documents change only, it'll be good if you could review the markdown format and wording
Is there a release notes update needed for this change?:
Add Changelog.md to the repo and update related markdown files, such as README, Contributing...