Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog #4448

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add changelog #4448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
516dff0
Add changelog
aaruni96 Jan 10, 2025
16b514c
Remove the changelog nagger
aaruni96 Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
tries to adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [Unreleased]

### Added

- Started keeping a changelog. Added a changelog file, and added a changelog nagger to CI.

### Changed

### Deprecated

### Removed

### Fixed

### Security
Comment on lines +22 to +23
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Security

I don't think this is a category that is relevant for us... or if it ever becomes, we can add it :-)

On the other hand, I wonder how breaking changes fit into this scheme: right now "breaking" could appear under "changed" or "removed" (and arguably even under "fixed"). But we should make breaking changes prominent. I see two options:

  1. Add another section "Breaking" (I'd put it first) and put them all in there, no matter whether they remove or change something
  2. Use these categories but then always put Breaking: in front of breaking changes

(As @thofma pointed out for OSCAR this shouldn't be relevant for some time, but certainly for AA and Nemo. But I am asking this here in the hopes that more people will see it this way).

Loading