Skip to content

docs(CHANGELOG): make changelog keepachangelog compliant#199

Merged
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/changelog
Jun 22, 2026
Merged

docs(CHANGELOG): make changelog keepachangelog compliant#199
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/changelog

Conversation

@mdevolde

Copy link
Copy Markdown
Collaborator

docs(CHANGELOG): make changelog keepachangelog compliant

Why the pull request was made

To have a changelog that is keepachangelog compliant, allowing users to follow the changes that are implemented since latest release.

Summary of changes

  • Edit the changelog to follow keepachangelog conventions.
  • Add an Unreleased section.
  • Split releases in sub-sections.
  • Make releases titles cliquable.
  • Add a short introduction and edit the title.
  • Edit pull request template to ask to edit changelog in PRs (and to add a change category "chore").
  • Edit contributing file to ask to edit changelog in PRs.

Screenshots (if appropriate):

Not applicable.

How has this been tested?

Not applicable.

Resources

https://keepachangelog.com/en/2.0.0/

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to documentation only)
  • Refactor / code style update (non-breaking change that improves code structure or readability)
  • Tests / CI improvement (adding or updating tests or CI configuration only)
  • Other (please describe):

Checklist

  • Followed the project's contributing guidelines.
  • Updated any relevant tests.
  • Updated any relevant documentation.
  • Added comments to your code where necessary.
  • Formatted your code, run the linters, checked types and tests.

@mdevolde mdevolde self-assigned this Jun 22, 2026
@mdevolde mdevolde merged commit 23dc3b8 into jxmorris12:master Jun 22, 2026
12 checks passed
@mdevolde mdevolde deleted the docs/changelog branch June 22, 2026 19:53
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.46%. Comparing base (27493eb) to head (8b1c2c4).
⚠️ Report is 1 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #199   +/-   ##
=======================================
  Coverage   80.46%   80.46%           
=======================================
  Files          13       13           
  Lines        1746     1746           
=======================================
  Hits         1405     1405           
  Misses        341      341           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants