search

qiboteam / qibocal

Quantum calibration, characterization and validation module for Qibo.
https://qibo.science
Apache License 2.0
31 stars 7 forks source link

Customize release notes #652

Open andrea-pasquale opened 10 months ago

andrea-pasquale commented 10 months ago

I think that this could be useful given that the library is still quite unstable.

alecandido commented 10 months ago

A good guide: https://keepachangelog.com/en/1.1.0/

there are even useful tools for doing this: https://git-cliff.org/ https://github.com/github-changelog-generator/github-changelog-generator

andrea-pasquale commented 10 months ago

It seems that

https://git-cliff.org/

works using conventional commits which I think that could be nice to use. Actually if we want to enforce them there is also a pre-commit hook, but perhaps this is too much...

The other option will be just to have a CHANGELOG.md and the author of the PR should be responsible for updating it.