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

docs: add CHANGELOG.md #220

Merged
merged 1 commit into from
Jan 17, 2025
Merged

docs: add CHANGELOG.md #220

merged 1 commit into from
Jan 17, 2025

Conversation

lferrigno
Copy link
Contributor

This PR introduces a changelog to the repository, ensuring clear documentation of changes, improvements, and updates across releases. By maintaining a changelog, we aim to:

  • Improve Transparency: Provide developers and users with a clear record of new features, fixes, and breaking changes.
  • Enhance Collaboration: Enable contributors to stay informed about the evolution of the codebase.
  • Facilitate Communication: Easily track progress and updates.

Implementation

  • A CHANGELOG.md file has been added at the root of the repository.
  • The changelog format adheres to Keep a Changelog guidelines, ensuring consistency and clarity.
  • Initial entries include the most recent version and its functionality.

Proposed Workflow

  • All PRs introducing new features, fixes, or breaking changes should include a changelog update.
  • Use semantic versioning for tracking changes, with clear tags for added, changed, deprecated, fixed, and removed items.

Future Steps

  • Update the contribution guidelines to include a section on maintaining the changelog.

@lferrigno lferrigno requested a review from afkbyte January 15, 2025 19:26
@MegaRedHand
Copy link
Contributor

MegaRedHand commented Jan 17, 2025

We might be able to autogenerate something similar with https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
We'd still need to label PRs correctly

@MegaRedHand MegaRedHand merged commit 6969091 into main Jan 17, 2025
2 of 3 checks passed
@MegaRedHand MegaRedHand deleted the add-changelog branch January 17, 2025 16:14
@MegaRedHand MegaRedHand added the changelog-documentation [changelog] PR adds or modifies documentation label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-documentation [changelog] PR adds or modifies documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants