Skip to content

Commit 0aa9845

Browse files
committed
docs: add changelog and semantic versioning guidance
1 parent fd16538 commit 0aa9845

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

.github/release.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changelog:
2+
categories:
3+
- title: Features
4+
labels:
5+
- enhancement
6+
- feature
7+
- title: Fixes
8+
labels:
9+
- bug
10+
- title: Documentation
11+
labels:
12+
- documentation
13+
- title: CI/CD
14+
labels:
15+
- ci
16+
- title: Maintenance
17+
labels:
18+
- chore
19+
- task
20+
exclude:
21+
labels:
22+
- skip-changelog

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
The format is based on Keep a Changelog and this project uses semantic versioning.
6+
7+
## [Unreleased]
8+
9+
### Added
10+
11+
- GitHub issue templates, PR template, and CODEOWNERS.
12+
- CI and release workflows.
13+
- Build and release helper scripts.
14+
- Publishing and contribution guides.
15+
16+
## [0.1.0] - 2026-02-22
17+
18+
### Added
19+
20+
- Initial macOS SwiftUI cleaner app.
21+
- Category-based cleanup planning and execution engine.
22+
- Terminal-style cleanup output in preview tab.
23+
- Permanent deletion mode for selected cleanup targets.
24+
- App icon set and polished UI structure.

docs/VERSIONING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Versioning Strategy
2+
3+
This repository follows semantic versioning:
4+
5+
- `MAJOR`: breaking behavior changes
6+
- `MINOR`: backward-compatible features
7+
- `PATCH`: backward-compatible fixes
8+
9+
Git tags follow this exact format:
10+
11+
- `vMAJOR.MINOR.PATCH`
12+
13+
Examples:
14+
15+
- `v0.1.0`
16+
- `v0.2.1`
17+
- `v1.0.0`
18+
19+
## Release checklist
20+
21+
1. Ensure `main` is green in CI.
22+
2. Update `CHANGELOG.md`.
23+
3. Create and push annotated tag.
24+
4. Verify GitHub release artifact is generated.
25+
5. Announce release notes.

0 commit comments

Comments
 (0)