Discuss: Support Conventionnal Comments

[silopolis]

Hi,

First, thanks for this rocking project. I'm a huge fan of TODOs, FIXMEs and other "typed comments", after IDEs/editors extensions supporting them, integration with code management platform just puts them on steroid!

I'm opening this more for discussion than to request features, but don't hold yourself ;)

Once more serious maters will be addressed, it could be fantastic to leverage those efforts by supporting Conventional Comments (repository). This could create potential uses in so many different cases!

See this issue about the definition of a format spec.

TY

[alstr]

Thanks for the positive comments. I'm always open to improving the action and for others to chip in however they want.

How do you propose the Conventional Comments support could work? Sounds interesting.

[silopolis]

After spending some time on this matter, and reading again the README (hence #145), I finally believe that the specification to follow should be the Conventionnal Commits' one (itself integrating the git trailer convention), already leveraged by the Conventional Changelog one and a growing set of tools.

Good thing is that there seems to be no big difference with the current implementation and that it would work pretty much as it does today :)

I believe there could be nice opportunities in using the same, or compatible, standard from the initial code comment (block), to commit, and review. These could emerge both in-process for automation, management, and communication, as well as for code/project documentation to extend or complement changelog/release notes. Could be another powerful tool in the #docs-as-code chest...

[alstr]

The latest update does include some new TODO reference options, e.g. TODO(!mylabel). That is about as close as I've gotten to supporting Conventional Commits at the moment, but I'm always open to further ideas.