Skip to content

Commit bfc7645

Browse files
authored
docs: view scope as optional (#67)
* docs: view scope as optional * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
1 parent 3ad9659 commit bfc7645

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -236,17 +236,17 @@ If there isn't an existing DESIGN.md file:
236236
237237
PR names must be:
238238

239-
1. **User-focused**: Describe what users gain, not technical implementation
240-
1. **Follow [Conventional Commits](https://www.conventionalcommits.org)**
241-
1. **Clear & simple** (present tense, action-oriented)
239+
1. **User-focused**: Describe what users gain, not technical implementation
240+
1. **Follow [Conventional Commits](https://www.conventionalcommits.org)**
241+
1. **Clear & simple** (present tense, action-oriented)
242242

243243
### Example Comparison
244244

245-
| **Good Examples** | **Bad Examples** | **Why?** |
246-
|-----------------------------|----------------------------------|---------|
247-
| `feat(ui): play music` | `Create player` | Missing scope/type |
248-
| `fix(sdk): mute sound` | `Fix: add file to mute sound` | Technical details |
249-
| `test(api): open door` | `Feat: modified door function` | Vague, past tense |
245+
| **Good Examples**| **Bad Examples**| **Why?** |
246+
| ---------------------- | ------------------------------ | ------------------ |
247+
| `feat(ui): play music` | `Create player` | Missing scope/type |
248+
| `fix(sdk): mute sound` | `Fix: add file to mute sound` | Technical details |
249+
| `test(api): open door` | `Feat: modified door function` | Vague, past tense |
250250

251251
---
252252

@@ -255,32 +255,32 @@ PR names must be:
255255
#### What to Focus On
256256

257257
A feature isn’t a button, toggle, or handler—it’s
258-
**what the user gains from it**. Ask:
258+
**what the user gains from it**. Ask:
259259

260-
-*"What am I building?"* → Leads to technical labels.
261-
-*"What will users be able to do?"* → Leads to clear value.
260+
-_"What am I building?"_ → Leads to technical labels.
261+
-_"What will users be able to do?"_ → Leads to clear value.
262262

263263
#### Why It Matters
264264

265265
- **Clarity**: Engineers, PMs, and stakeholders instantly understand the impact.
266-
- **Consistency**: Aligns with product-facing language (release notes, docs).
267-
- **User-Centricity**: Work is driven by user needs, not just code changes.
266+
- **Consistency**: Aligns with product-facing language (release notes, docs).
267+
- **User-Centricity**: Work is driven by user needs, not just code changes.
268268

269269
#### How to Apply It
270270

271271
1. **Replace UI labels with actions**: Wrong: "Add dropdown for filters" →
272-
Correct:"Filter search results by category"
272+
Correct:"Filter search results by category"
273273
1. **Describe outcomes, not components**: Wrong: "Fix API error handling" →
274-
Correct:"Gracefully recover from connection errors"
274+
Correct:"Gracefully recover from connection errors"
275275

276-
1. **Use user action verbs**: *View, Play, Customize, Save*, etc.
276+
1. **Use user action verbs**: _View, Play, Customize, Save_, etc.
277277

278278
### Before Submitting, Ask
279279

280-
1. Does it use `type(scope): action` format?
281-
1. Could a non-technical user understand the benefit?
282-
1. Is it in the present tense?
283-
1. Does it focus on user capability (not code)?
280+
1. Does it use `type(scope [Optional]): action` format?
281+
1. Could a non-technical user understand the benefit?
282+
1. Is it in the present tense?
283+
1. Does it focus on user capability (not code)?
284284

285285
## Requesting Review
286286

0 commit comments

Comments
 (0)