Atleta-network / atleta

GNU General Public License v3.0
6 stars 3 forks source link

Add changelog #45

Open ales-tsurko opened 3 months ago

ales-tsurko commented 3 months ago

We should considered wether the changelog should be generated from the commit history or modified manually.

In case of manual logging we need to configure CI/CD so that it checks the changelog updataed on new release (or, for example, branch merge).

In case of generated changelog, we should prevent it to be messy and configure CI/CD, which would check the style (for example, merge commit messages). Also, we should have strict guideline related to commit messages or anything else which would go into the log.

We should avoid to switching conventional commits for that, as the changelogs generated from repos sticked to this practice use to have messy changelogs.

For the changelog itself, we should follow these guidelines.

ales-tsurko commented 3 months ago

In discussion we considered doing it this way: