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.

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

CHANGELOG.md does not adhere completely to the Keep A Changelog format #253

Closed
LikeLakers2 opened this issue Mar 28, 2023 · 3 comments · Fixed by #256
Closed

CHANGELOG.md does not adhere completely to the Keep A Changelog format #253

LikeLakers2 opened this issue Mar 28, 2023 · 3 comments · Fixed by #256
Assignees
Labels

Comments

@LikeLakers2
Copy link
Contributor

Hi! I was looking through some crates on crates.io, and I happened to chance upon the CHANGELOG.md file within this repository.

I noticed that it didn't quite adhere properly to the Keep A Changelog format - despite claiming otherwise in its opening lines. For example:

  • The header is Change Log instead of Changelog (pedantic, I know, but it's good to be consistent c: )
  • The 1.0.0 - 2023-??-?? is clearly representative of an Unreleased section - so it should be labeled as such.
  • The various sections under each version ("Breaking Changes", "New Features", "Improvements", "Fixes") do not match the "Types of changes" that Keep A Changelog proposes to use.

To be clear, I'm being pedantic with all this. The changelog is actually fine as-is! Importantly, it's kept consistent, so it's not as if it's hard to read.

But if you'd allow me, I'd gladly go through and rewrite (or rather, rearrange) CHANGELOG.md to fix the things listed above. Would that be okay?

@LikeLakers2 LikeLakers2 changed the title CHANGELOG.md does not adhere properly to the Keep A Changelog format CHANGELOG.md does not adhere completely to the Keep A Changelog format Mar 28, 2023
@JelteF
Copy link
Owner

JelteF commented Mar 28, 2023

Sounds good to me. Seems like an easy to review PR (I love receiving those)

@LikeLakers2
Copy link
Contributor Author

Okay! I'll start work on it sometime in the next couple days (currently working on my own projects and all).

@tyranron
Copy link
Collaborator

Fixed in #256

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