diff --git a/path/to/CHANGELOG.md b/path/to/CHANGELOG.md new file mode 100644 index 0000000..fd4c0e5 --- /dev/null +++ b/path/to/CHANGELOG.md @@ -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 \ No newline at end of file diff --git a/path/to/CONTRIBUTING.md b/path/to/CONTRIBUTING.md new file mode 100644 index 0000000..f7977d8 --- /dev/null +++ b/path/to/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +We welcome contributions from the community! Please follow these guidelines when submitting changes. + +## Updating the Changelog + +- **Before merging**: Ensure the `CHANGELOG.md` is updated for the new release. +- **Format**: Follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. +- **Content**: Include a new section for the upcoming release under `[Unreleased]`, and add entries for each change in previous releases. +- **Links**: Add GitHub release URLs for each tagged version. + +Example: +```markdown +## [Unreleased] + +- Add new feature X. +- Fix bug Y. + +## [v1.0.0] - 2023-10-01 + +- Initial release. +- Basic functionality implemented. +``` + +## Pull Requests + +- Open a pull request against the `main` branch. +- Include tests for new features or bug fixes. +- Reference relevant issues using `#issue-number`. \ No newline at end of file