Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions path/to/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 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

- Initial release with basic functionality.
9 changes: 9 additions & 0 deletions path/to/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing

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

- **Update the CHANGELOG**: After each merge to `main`, update the `CHANGELOG.md` file in the `Unreleased` section with a summary of your changes, following the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
- **Follow SemVer**: Ensure your changes align with our Semantic Versioning policy.
- **Run tests**: Make sure your changes pass the existing test suite before submitting.

Your contributions help keep our project transparent and easy to follow.