Refactor CHANGELOG for v0.27#9497
Conversation
f9c89fb to
7f32f6d
Compare
ahukkanen
left a comment
There was a problem hiding this comment.
Thanks @andreslucena, great as usual.
I just noticed one formatting error. Content-wise it's all good.
I wasn't quite sure how to format the CHANGELOG honestly, I was trying to "decrypt" from the previous ones but they seemed to have a bit difference in them, so it was a bit unclear to me as well. The content structure felt weird to me too, so great that we can get this improved.
Should we document the instructions somewhere how the CHANGELOG should be formatted? Or are they already somewhere?
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
As I've mentioned in the meeting, I like to try new things to see what works best 😄
I'll add this new structure with the boilerplate to the current CHANGELOG and also to the |
|
Ready to be reviewed again @ahukkanen |
ahukkanen
left a comment
There was a problem hiding this comment.
I have added some final suggestions below after testing this in real life and after working with the term customizer upgrade. The might be useful for instance implementors and module developers.
| ``` | ||
|
|
||
| #### New Api Documentation engine | ||
| ### 3. One time actions |
There was a problem hiding this comment.
You mentioned in the last weekly that you were not perfectly satisfied with this heading. I could not come up with any better either but here are some alternative suggestions that you can consider:
- Manual chores (or just Chores)
- Call to action (or CTA or Actions)
- Configuration
- Refinements (can be ambiguous)
- Finalization
Feel free to dismiss if the current one is better. Just tried to come up with some alternatives.
There was a problem hiding this comment.
I prefer the ones we have. Thanks for the options, though, I'll take this into account in the next release.
Suggested on code review Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
|
@ahukkanen I've added all your proposed changes already. Thanks for the feedback! |
Co-authored-by: Antti Hukkanen <antti.hukkanen@mainiotech.fi>
🎩 What? Why?
While reviewing the CHANGELOG for v0.27 I found it a bit weird to follow, as we had different sections unordered.
This PR tries to solve that by introducing Categories in the notes. I'm not 100% happy with the result, but I think it improves the readability of the notes.
As a summary, these are the proposed categories:
The main idea is that I shouldn't need to be jumping between sections, for instance when configuring the scheduled tasks.
I've also tried to simplify and make the wording consistent by changing the person to "We" and also by changing the "As per #XXX ...." to "You can read more about this change on PR XXX."
Testing
With GitHub raw text diff UI is impossible to read this, it's better to read it on https://github.com/decidim/decidim/blob/f9c89fb334298ba4c8a6f0fe84ba92c89b3220c6/CHANGELOG.md