mathe42 / vite-plugin-comlink

Use WebWorkers in Vite with comlink!
MIT License
170 stars 18 forks source link

Use Github Release feature to improve change documentation #131

Closed charlieforward9 closed 4 months ago

charlieforward9 commented 7 months ago

Hello! Thank you for providing this functionality for the open source community!

I was going through my Dependa-bot PRs and updating my dependancies. One thing I tend to do as I wait for the PRs to rebase between merges is check the changelog for each of the dependencies.

This helps me understand what has changed in the tools I use, to understand how they work, if I need to change anything, and gets me a little closer to the logic I depend on.

Usually the best spot for that is in a CHANGELOG file, but if you dont want to manually maintain something, I recommend using the Github Release feature, which does a great job auto-documenting the CHANGELOG based on your PR titles.

I hope you consider this as you continue developing this incredibly helpful plugin.

mathe42 commented 4 months ago

Sure.