Skip to content

fix: Add a CHANGELOG.md (#64) #140

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

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

fix: Add a CHANGELOG.md (#64) #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dc847a
fix: Add a CHANGELOG.md (#64)
BWM0223 Jun 21, 2026
89296fb
fix: Add a CHANGELOG.md (#64)
BWM0223 Jun 21, 2026
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
19 changes: 19 additions & 0 deletions path/to/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

- Initial release.

## [v0.1.0] - 2023-10-01

- First public release.
- Basic functionality implemented.
- Documentation updated.

[Unreleased]: https://github.com/your-org/your-repo/compare/v0.1.0...HEAD
[v0.1.0]: https://github.com/your-org/your-repo/releases/tag/v0.1.0
15 changes: 15 additions & 0 deletions path/to/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing

We welcome contributions from the community! Please follow these guidelines:

- **Update the CHANGELOG**: After each merge to `main`, ensure the `CHANGELOG.md` is updated with the new version and relevant changes. This should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format and include a new section for the unreleased version, followed by entries for each released version in descending order.

- **Semantic Versioning**: Use semantic versioning (MAJOR.MINOR.PATCH) to tag releases. Each tag should correspond to a release on GitHub, and the changelog should reflect the changes made in that release.

- **Pull Requests**: Open a pull request with a clear description of the changes and why they were made.

- **Code Style**: Please adhere to the project’s code style guidelines.

- **Testing**: Ensure your changes are covered by tests where applicable.

Thank you for contributing!