Skip to content

Commit 69cc6eb

Browse files
branchseerclaude
andauthored
chore: add changelog (#284)
## Changes - **Added `CHANGELOG.md`** — Initial changelog documenting recent user-facing changes including: - **Added `.claude/skills/update-changelog.md`** — A skill guide for maintaining the changelog. - **Updated `CLAUDE.md`** — Added a new "Changelog" section documenting the requirement to run `/update-changelog` for user-facing changes --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 2a8ee32 commit 69cc6eb

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

.claude/skills/update-changelog.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
description: Update CHANGELOG.md with a new entry for the current change
3+
user_invocable: true
4+
---
5+
6+
# Update Changelog
7+
8+
Add a new entry to `CHANGELOG.md` for the change being made in the current branch.
9+
10+
## Instructions
11+
12+
1. Read `CHANGELOG.md` to understand the current format.
13+
2. Determine the appropriate category for the change:
14+
- **Added** — new user-facing feature or capability
15+
- **Changed** — modification to existing user-facing behavior
16+
- **Removed** — removal of user-facing feature or option
17+
- **Fixed** — bug fix affecting users
18+
- **Perf** — performance improvement noticeable to users
19+
3. Write a concise, user-facing description. Focus on what changed from the user's perspective, not implementation details.
20+
4. Include a PR link in the format `([#NNN](https://github.com/voidzero-dev/vite-task/pull/NNN))`. If the PR number is not yet known, leave a `([#???](https://github.com/voidzero-dev/vite-task/pull/???))` placeholder.
21+
5. Insert the new entry at the **top** of the existing list in `CHANGELOG.md` (newest first).
22+
6. If the current change is closely related to an existing entry (e.g., multiple PRs contributing to the same feature or fix), group them into a single item with multiple PR links rather than adding a separate entry.
23+
24+
## What NOT to include
25+
26+
Do not add entries for:
27+
28+
- Internal refactors with no user-facing effect
29+
- CI/CD changes
30+
- Dependency bumps
31+
- Test-only fixes (flaky tests, test infrastructure)
32+
- Documentation changes (CLAUDE.md, README, etc.)
33+
- Chore/tooling changes
34+
35+
The changelog is for **end-users only**.
36+
37+
## Entry format
38+
39+
```
40+
- **Category** description ([#NNN](https://github.com/voidzero-dev/vite-task/pull/NNN))
41+
```

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
- **Changed** default untracked env patterns to align with Turborepo, covering more CI and platform-specific variables ([#262](https://github.com/voidzero-dev/vite-task/pull/262))
4+
- **Added** `--log=interleaved|labeled|grouped` flag to control task output display: `interleaved` (default) streams directly, `labeled` prefixes lines with `[pkg#task]`, `grouped` buffers output per task ([#266](https://github.com/voidzero-dev/vite-task/pull/266))
5+
- **Added** musl target support (`x86_64-unknown-linux-musl`) ([#273](https://github.com/voidzero-dev/vite-task/pull/273))
6+
- **Changed** cache hit/miss indicators to use neutral symbols (◉/〇) instead of ✓/✗ to avoid confusion with success/error ([#268](https://github.com/voidzero-dev/vite-task/pull/268))
7+
- **Added** automatic skip of caching for tasks that modify their own inputs ([#248](https://github.com/voidzero-dev/vite-task/pull/248))

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ All code must work on both Unix and Windows without platform skipping:
135135
- Platform differences should be handled gracefully, not skipped
136136
- After major changes to `fspy*` or platform-specific crates, run `just lint-linux` and `just lint-windows`
137137

138+
## Changelog
139+
140+
When a change is user-facing (new feature, changed behavior, bug fix, removal, or perf improvement), run `/update-changelog` to add an entry to `CHANGELOG.md`. Do not add entries for internal refactors, CI, dep bumps, test fixes, or docs changes.
141+
138142
## Quick Reference
139143

140144
- **Task Format**: `package#task` (e.g., `app#build`, `@test/utils#lint`)

0 commit comments

Comments
 (0)