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.
21 changes: 21 additions & 0 deletions path/to/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing

We welcome contributions from the community! Please follow these guidelines when submitting changes.

## Updating the Changelog

All changes must be reflected in the [CHANGELOG.md](CHANGELOG.md). When you make a significant change:

1. Ensure it aligns with our [Semantic Versioning](https://semver.org/spec/v2.0.0.html) policy.
2. Add an entry under the appropriate version section in the Changelog.
3. Include a brief description of the change and any notable impacts.

Keep the Changelog format consistent with the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) guidelines.

## Pull Requests

- Make sure your feature branches are up-to-date with the main branch.
- Include tests for new functionality.
- Describe the motivation and changes in the PR description.

We'll review your PR and provide feedback.