Skip to content

Commit 8be2e9e

Browse files
committed
.claude: move changelog writing into skill
1 parent 83d7f54 commit 8be2e9e

File tree

2 files changed

+62
-7
lines changed

2 files changed

+62
-7
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: write-changelog
3+
description: Write or update changelog entries with user-focused language
4+
---
5+
6+
# Changelog
7+
8+
Write or update changelog entries following these guidelines:
9+
10+
## Guidelines
11+
12+
- **Focus on user benefits** rather than implementation details
13+
- **Keep entries concise** - typically a single line without subpoints
14+
- **Emphasize what the user can now do** or how their experience improves
15+
- **Avoid technical specifics** like state management, CSS classes, or internal architecture
16+
17+
## Categories
18+
19+
Entries are organized under these category headings:
20+
21+
- `### ✨ Features` - New functionality for users
22+
- `### 🐛 Bug Fixes` - Corrections to existing behavior
23+
- `### 🔁 Changes` - Modifications to existing features
24+
- `### ⚙ Internal` - Technical changes (use sparingly, still user-focused)
25+
- `### 🌐 Translations` - New or updated translations
26+
- `### Breaking changes` - For major releases only
27+
- `### Deprecated` - Features being phased out
28+
29+
## Unreleased Section
30+
31+
Always add new entries to the `## Unreleased` section at the top of the changelog. Create the appropriate category heading if it doesn't exist yet. Entries are moved to a versioned section during the release process.
32+
33+
## Examples
34+
35+
Good:
36+
37+
- "Added keyboard shortcuts for common actions"
38+
- "Tasks now sync automatically when Obsidian starts"
39+
- "Fixed tasks not appearing after editing"
40+
41+
Bad:
42+
43+
- "Refactored TaskStore to use Redux pattern with selectors"
44+
- "Added `useEffect` hook to trigger sync on mount"
45+
- "Fixed CSS specificity issue in task-list component"
46+
47+
## Location
48+
49+
The changelog is located at `docs/docs/changelog.md`.

docs/CLAUDE.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,53 +11,62 @@ This is the documentation site for the Sync with Todoist Plugin for Obsidian. Th
1111
All commands should be run from this `docs/` directory:
1212

1313
### Development
14+
1415
- `npm start` - Start local development server (usually runs on http://localhost:3000)
1516
- `npm run build` - Build documentation site for production
1617
- `npm run serve` - Serve built site locally
1718
- `npm run clear` - Clear Docusaurus cache
1819

1920
### Documentation Management
21+
2022
- `npm run bump-version -- ${VERSION}` - Create new versioned documentation (e.g., `npm run bump-version -- 2.2.0`)
2123
- `npm run write-translations` - Extract translatable strings
2224
- `npm run write-heading-ids` - Add heading IDs to markdown files
2325

2426
### Quality
27+
2528
- `npm run typecheck` - Run TypeScript type checking
2629

2730
## Documentation Structure
2831

2932
### Core Documentation (`docs/`)
33+
3034
- `overview.md` - Main plugin introduction and features
3135
- `setup.md` - Installation and initial configuration
3236
- `configuration.md` - Detailed plugin settings
3337
- `query-blocks.md` - Query language documentation
3438
- `changelog.md` - Version history and changes
3539

3640
### Commands Documentation (`docs/commands/`)
41+
3742
- `add-task.md` - Creating tasks from Obsidian
3843
- `sync-with-todoist.md` - Manual sync functionality
3944

4045
### Contributing Documentation (`docs/contributing/`)
46+
4147
- `general.md` - Development setup and workflow
4248
- `release-process.md` - How to release new versions
4349
- `translation.mdx` - Translation contribution guide
4450

4551
## Versioned Documentation
4652

4753
The site supports versioned documentation with past versions stored in:
54+
4855
- `versioned_docs/version-X.Y.Z/` - Snapshot of docs for each version
4956
- `versioned_sidebars/` - Sidebar configuration for each version
5057
- `versions.json` - List of available versions
5158

5259
## Site Configuration
5360

5461
### Docusaurus Config (`docusaurus.config.ts`)
62+
5563
- Site metadata and URL configuration
5664
- GitHub Pages deployment settings
5765
- Theme and navigation configuration
5866
- Versioning setup
5967

6068
### Customization
69+
6170
- `src/css/custom.css` - Site-wide styling overrides
6271
- `src/components/` - Custom React components
6372
- `src/pages/` - Custom pages (like the homepage)
@@ -66,22 +75,19 @@ The site supports versioned documentation with past versions stored in:
6675
## Development Notes
6776

6877
### Adding New Documentation
78+
6979
1. Create markdown files in the `docs/` directory
7080
2. Update `sidebars.ts` to include new pages in navigation
7181
3. Use MDX format for pages requiring React components
7282

73-
### Changelog Guidelines
74-
- Focus on user benefits rather than implementation details
75-
- Keep feature entries concise - typically a single line without subpoints
76-
- Emphasize what the user can now do or how their experience improves
77-
- Avoid technical specifics like state management, CSS classes, or internal architecture
78-
7983
### Managing Versions
84+
8085
- Only cut new documentation versions for minor/major releases
8186
- Patch releases typically don't need new doc versions
8287
- Version bumping copies current docs to versioned storage
8388

8489
### Translation Support
90+
8591
- Site is configured for internationalization but currently English-only
8692
- Translation status tracking in `translation-status.json`
87-
- Custom `TranslationStatus` component for displaying translation progress
93+
- Custom `TranslationStatus` component for displaying translation progress

0 commit comments

Comments
 (0)