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

Jump to bottom

Add more documentation around changelog entries #1914

Closed
mcmire opened this issue Oct 25, 2023 · 1 comment
Closed

Add more documentation around changelog entries #1914

mcmire opened this issue Oct 25, 2023 · 1 comment
Labels
team-wallet-framework

Comments

@mcmire
Copy link
Contributor

mcmire commented Oct 25, 2023

The Keep a Changelog spec provides some basic guidance on how to use changelog categories:

Added for new features.
Changed for changes in existing functionality.
Deprecated for soon-to-be removed features.
Removed for now removed features.
Fixed for any bug fixes.
Security in case of vulnerabilities.

But as we've been updating changelogs, we've noticed some confusion around how to use these (particularly Added, Removed, Changed, and Fixed). We should document tangible use cases in the Contributing doc to dispel this confusion.
@mcmire
Copy link
Contributor Author

mcmire commented Jan 6, 2025

This has been fixed for a while.

@mcmire mcmire closed this as completed Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mcmire @desi and others