8
8
<img alt =" License " src =" https://img.shields.io/badge/license-MIT-blue.svg " >
9
9
<img alt =" ESLint " src =" https://img.shields.io/badge/lint-ESLint-4B32C3?logo=eslint&logoColor=white " >
10
10
<img alt =" Prettier " src =" https://img.shields.io/badge/format-Prettier-F7B93E?logo=prettier&logoColor=black " >
11
+ <img alt =" Conventional Commits " src =" https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg " >
11
12
</p >
12
13
13
14
A tiny, fast notes app as a ** pure frontend** demo. No backend or bundler required — just open it via a local web server.
@@ -31,6 +32,7 @@ Pairs with **[notes-backend](https://github.com/rluetken-dev/notes-backend)**. T
31
32
- [ Keyboard Shortcuts] ( #keyboard-shortcuts )
32
33
- [ Linting & Formatting] ( #linting--formatting )
33
34
- [ Scripts] ( #scripts )
35
+ - [ Commits & Changelog] ( #commits--changelog )
34
36
- [ Data & Privacy] ( #data--privacy )
35
37
- [ Roadmap] ( #roadmap )
36
38
- [ Deployment] ( #deployment )
@@ -45,7 +47,7 @@ Pairs with **[notes-backend](https://github.com/rluetken-dev/notes-backend)**. T
45
47
- ✍️ ** Create / edit / delete notes**
46
48
- 📌 ** Pin** important notes to keep them on top
47
49
- 🔎 ** Live search** (title & content)
48
- - #️⃣ ** #tags in search** (AND filter; tags are extracted on‑ the‑ fly from title/content)
50
+ - #️⃣ ** #tags in search** (AND filter; tags are extracted on- the- fly from title/content)
49
51
- ✨ ** Search highlighting** (` <mark> ` for text; highlighted tag chips)
50
52
- ⬇️⬆️ ** Export / Import** (JSON; merge or replace existing notes)
51
53
- 🌓 ** Dark Mode** with ** system detection** & ** toggle** (persisted in ` localStorage ` )
@@ -152,8 +154,8 @@ notes-frontend/
152
154
153
155
- ` #work ` → notes tagged ` #work `
154
156
- ` #work #inbox ` → notes that have ** both** tags
155
- - ` meeting ` → full‑ text search
156
- - ` meeting #work ` → full‑ text ** and** tag filter
157
+ - ` meeting ` → full- text search
158
+ - ` meeting #work ` → full- text ** and** tag filter
157
159
158
160
---
159
161
@@ -192,7 +194,7 @@ notes-frontend/
192
194
193
195
- ** Save new note:** ` Ctrl/Cmd + Enter `
194
196
- ** Theme toggle:** click ` 🌓 `
195
- - Right‑ click on ` 🌓 ` → reset to ** System**
197
+ - Right- click on ` 🌓 ` → reset to ** System**
196
198
197
199
---
198
200
@@ -221,6 +223,25 @@ npm run format
221
223
222
224
---
223
225
226
+ ## Commits & Changelog
227
+
228
+ This repo follows ** Conventional Commits** to keep history and changelogs clean.
229
+ See ** [ commits.md] ( ./commits.md ) ** for the rules, allowed types, scopes, and examples.
230
+
231
+ ** Examples**
232
+
233
+ - ` feat(ui): add search highlight for tags `
234
+ - ` fix(storage): handle empty import file gracefully `
235
+ - ` docs: update README with screenshots `
236
+ - ` chore(prettier): format markdown `
237
+
238
+ ** Releases**
239
+
240
+ - Tag releases as ` vX.Y.Z ` (SemVer).
241
+ - Keep release notes concise and link the compare view.
242
+
243
+ ---
244
+
224
245
## Data & Privacy
225
246
226
247
- All data is stored ** locally in the browser** via ` localStorage ` .
@@ -236,7 +257,7 @@ npm run format
236
257
- Tag management (rename/delete, suggestions while typing)
237
258
- Result snippets (show a short context around search hits)
238
259
- Sorting options (e.g., by ` updatedAt ` , ` title ` )
239
- - Markdown preview (read‑ only render)
260
+ - Markdown preview (read- only render)
240
261
- PWA (offline, installable)
241
262
- IndexedDB storage (scales better than localStorage)
242
263
- Tests: unit (Vitest) & end-to-end (Playwright)
0 commit comments