An often overlooked, underappreciated, and seemingly mundane stage of the development cycle is the process of writing a changelog. For those who ar...
For further actions, you may consider blocking this person and/or reporting abuse
no need to write it ! just autogen from your github commits !
Yup, that's fine, too! But of course, a personal touch is always better than automatically generated changelogs. 😉
But if the time and resource constraints are indeed limited, then that is a viable option.
Best thing that worked to me is to squash on merge request, so you can use whatever commit message you want during development, use a nice "changelog" message just on the merge request, then you can generate the entire changelog from the main branch and it will be perfectly fine. Best of both worlds! 😁
True enough, I've been seeing this more frequently in many open-source projects thanks to the rise of GitHub Actions and other automations. I personally still prefer the labor of love that comes from a handwritten changelog1, but something is better than nothing. I cannot complain about that.
See this recent example from the Bevy game engine. ↩
You can achieve exactly the same!
you put a bit of effort and love the same way, just on a different stage 😂
Just write your MR comments in markdown and post-it with a parser process (just like dev.to does in posts and comments) 😁
Preach preach... Loved the article
Thanks! I'm glad you liked it. 😉
Great article, as always!
P.S. You might consider adding the
#opensourcetag.Sure! Will do. Never really thought it would be particularly relevant until you mentioned it.
💯