diff --git a/path/to/CHANGELOG.md b/path/to/CHANGELOG.md new file mode 100644 index 0000000..58b5a0b --- /dev/null +++ b/path/to/CHANGELOG.md @@ -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. \ No newline at end of file diff --git a/path/to/CONTRIBUTING.md b/path/to/CONTRIBUTING.md new file mode 100644 index 0000000..fec1a82 --- /dev/null +++ b/path/to/CONTRIBUTING.md @@ -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. \ No newline at end of file