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
19 changes: 19 additions & 0 deletions path/to/CHANGELOG.md
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
29 changes: 29 additions & 0 deletions path/to/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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`.