Documenting breaking changes in changelog

[lukashornych]

For projects where we use evitaDB, we need clear list of potential breaking changes for each evitaDB version in changelog. Currently, only way to know if there was a breaking change, is go through all PRs in changelog and for each issue check if there is a breaking flag, and if so, scan the entire issue for some comment of what has changed.

This is not intuitive, certainly not productive, and more importantly error prone. We need a way to communicate breaking changes to developers integrating evitaDB, ideally in the release changelog together with all changes for a particular version.

Proposed solution

First, we need to fully conform to conventional commits and how breaking changes should be annotated in commit messages and PR titles, i.e. feat(scope)!: ....

When a breaking change occurs in an issue, a developer assigned to the issue will label the issues with a breaking change label and will aggregate all information (what changes and what to do about it in a project integrating evitaDB) about the breaking changes in the issues description.

Ideally, we would want to autolabel issues by commit messages, but we will see if it is doable without spending too much time implementing it.

When a pull request is then creating for issues to merge, autolabeler will autolabel the PR based on the PR title in the conventional commits format. The PR description must contain all the issues it solves (check out docs).

Finally, we will display both PR title and description in the release notes, so that developers can directly check out the breaking issues. The release notes description will now have 3 categories of PRs: Breaking changes, Features and Changes.

We should also document how to write commit messages, issues and PRs.

• auto label issue based on commit messages
• auto label PR based on its title
• categorize changes in release notes
• display PR description in release notes
• document guidelines for issues, commits and PRs

[lukashornych]

@novoj The main functionality (auto label PRs, categorize PRs) is in the dev. The issue auto labeler is a bit more complicated than I anticipated. I will try to implement it when I have a little bit of free time, so we could deploy it in a next phase.