Skip to content

feat: add detailed changelog automation docs #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 19, 2024
Merged

feat: add detailed changelog automation docs #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,23 @@ This project uses GitHub's project management features to track issues, pull req

Our changelog follows the [Keep a Changelog](https://keepachangelog.com/) format and is automatically updated when PRs are merged.

### Changelog Management

This repository uses automated changelog generation through GitHub Actions. When you create a PR:

1. Use conventional commit format in PR titles:
- `feat:` for new features (increments minor version)
- `fix:` for bug fixes (increments patch version)
- `feat!:` or include `BREAKING CHANGE` for breaking changes (increments major version)
- `docs:` for documentation changes
- `refactor:` for code changes that neither fix bugs nor add features

2. The workflow will automatically:
- Skip changelog updates for changelog-only PRs
- Create a new changelog entry based on your PR title and description
- Increment version number according to semantic versioning
- Create a new PR with the changelog update

### Automated Changelog

This project uses an automated changelog workflow that:
Expand Down
Loading