You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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`.
0 commit comments