From 0bd6a9b63b296eb9f007c176ac2846a88d7355aa Mon Sep 17 00:00:00 2001 From: Angelica Willianto Date: Thu, 27 Nov 2025 19:34:08 +0800 Subject: [PATCH 1/4] docs: view scope as optional --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f29730a..d24640e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -236,7 +236,7 @@ A feature isn’t a button, toggle, or handler—it’s **what the user gains fr ### Before Submitting, Ask -1. Does it use `type(scope): action` format? +1. Does it use `type(scope [Optional]): action` format? 2. Could a non-technical user understand the benefit? 3. Is it in the present tense? 4. Does it focus on user capability (not code)? From 9f3ef686c9fc06d9630c6f8b894378723b16db3e Mon Sep 17 00:00:00 2001 From: Angelica Willianto Date: Sun, 30 Nov 2025 23:14:14 +0800 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c7b953e..0ecee90 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -236,17 +236,17 @@ If there isn't an existing DESIGN.md file: PR names must be: -1. **User-focused**: Describe what users gain, not technical implementation -1. **Follow [Conventional Commits](https://www.conventionalcommits.org)** -1. **Clear & simple** (present tense, action-oriented) +1. **User-focused**: Describe what users gain, not technical implementation +1. **Follow [Conventional Commits](https://www.conventionalcommits.org)** +1. **Clear & simple** (present tense, action-oriented) ### Example Comparison -| **Good Examples** ✅ | **Bad Examples** ❌ | **Why?** | -|-----------------------------|----------------------------------|---------| -| `feat(ui): play music` | `Create player` | Missing scope/type | -| `fix(sdk): mute sound` | `Fix: add file to mute sound` | Technical details | -| `test(api): open door` | `Feat: modified door function` | Vague, past tense | +| **Good Examples** ✅ | **Bad Examples** ❌ | **Why?** | +| ---------------------- | ------------------------------ | ------------------ | +| `feat(ui): play music` | `Create player` | Missing scope/type | +| `fix(sdk): mute sound` | `Fix: add file to mute sound` | Technical details | +| `test(api): open door` | `Feat: modified door function` | Vague, past tense | --- @@ -255,34 +255,34 @@ PR names must be: #### What to Focus On A feature isn’t a button, toggle, or handler—it’s -**what the user gains from it**. Ask: +**what the user gains from it**. Ask: -- ❌ *"What am I building?"* → Leads to technical labels. -- ✅ *"What will users be able to do?"* → Leads to clear value. +- ❌ _"What am I building?"_ → Leads to technical labels. +- ✅ _"What will users be able to do?"_ → Leads to clear value. #### Why It Matters - **Clarity**: Engineers, PMs, and stakeholders instantly understand the impact. -- **Consistency**: Aligns with product-facing language (release notes, docs). -- **User-Centricity**: Work is driven by user needs, not just code changes. +- **Consistency**: Aligns with product-facing language (release notes, docs). +- **User-Centricity**: Work is driven by user needs, not just code changes. #### How to Apply It 1. **Replace UI labels with actions**: Wrong: "Add dropdown for filters" → - Correct:"Filter search results by category" + Correct:"Filter search results by category" 1. **Describe outcomes, not components**: Wrong: "Fix API error handling" → - Correct:"Gracefully recover from connection errors" + Correct:"Gracefully recover from connection errors" -1. **Use user action verbs**: *View, Play, Customize, Save*, etc. +1. **Use user action verbs**: _View, Play, Customize, Save_, etc. ### Before Submitting, Ask -### Before Submitting, Ask -1. Does it use `type(scope [Optional]): action` format? -2. Could a non-technical user understand the benefit? -3. Is it in the present tense? -4. Does it focus on user capability (not code)? +### Before Submitting, Ask +1. Does it use `type(scope [Optional]): action` format? +2. Could a non-technical user understand the benefit? +3. Is it in the present tense? +4. Does it focus on user capability (not code)? ## Requesting Review From 52daedb5addd86d05e96e145406f81243302b325 Mon Sep 17 00:00:00 2001 From: Angelica Willianto Date: Sun, 30 Nov 2025 23:15:01 +0800 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0ecee90..7508cb8 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -277,8 +277,6 @@ A feature isn’t a button, toggle, or handler—it’s ### Before Submitting, Ask -### Before Submitting, Ask - 1. Does it use `type(scope [Optional]): action` format? 2. Could a non-technical user understand the benefit? 3. Is it in the present tense? From 32680f66298fe6ed149eb72fa6ab698b33b5fe1f Mon Sep 17 00:00:00 2001 From: Angelica Willianto Date: Sun, 30 Nov 2025 23:17:18 +0800 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7508cb8..30559c7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -278,9 +278,9 @@ A feature isn’t a button, toggle, or handler—it’s ### Before Submitting, Ask 1. Does it use `type(scope [Optional]): action` format? -2. Could a non-technical user understand the benefit? -3. Is it in the present tense? -4. Does it focus on user capability (not code)? +1. Could a non-technical user understand the benefit? +1. Is it in the present tense? +1. Does it focus on user capability (not code)? ## Requesting Review