Skip to content

Commit 77a4742

Browse files
committed
docs: view better structure
1 parent b2b263e commit 77a4742

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community
77
approachable and respectful.
88

99
> [!TIP]
10-
> You can use [Wizard Github App][2] and [Wizard Browser Extension][1] to simplify some of the workflows
11-
> described in these Guidelines.
10+
> You can use [Wizard Github App][2] and [Wizard Browser Extension][1] to
11+
> simplify some of the workflows described in these Guidelines.
1212
1313
## Table of Contents
1414

@@ -73,8 +73,8 @@ Sometimes, a Goal already has a few identified problems, but not always.
7373
> clear.
7474
>
7575
> The statement must read as a **job story**: describe what the specific user
76-
> **can't do** or what is broken for them. Ask: _"What can [user] not do
77-
> because of this problem?"_
76+
> **can't do** or what is broken for them. Ask:
77+
> _"What can [user] not do because of this problem?"_
7878
7979
| **Good**| **Bad**| **Why?** |
8080
| ---------------------------------------------- | -------------------------------------------- | ------------------------------ |
@@ -108,7 +108,8 @@ Direct discussions to the appropriate channel at all times:
108108

109109
- **Spec document** — clarifications about Goal scope or business context
110110
- **Problem issues** — tracking obstacles that prevent achieving the Goal
111-
- **Goal issues** — linking Specs, tracking Problems, and monitoring progress only
111+
- **Goal issues** — linking Specs, tracking Problems, and monitoring progress
112+
only
112113

113114
> [!IMPORTANT]
114115
> Do not post Problem status updates, PR notifications, or progress updates in
@@ -126,10 +127,9 @@ issue so the dependency is visible.
126127

127128
### Referencing issues and PRs
128129

129-
When referencing issues or pull requests, use a list
130-
item format to enable automatic title rendering and improve readability. This
131-
ensures that GitHub automatically expands the reference to show the issue/PR
132-
title.
130+
When referencing issues or pull requests, use a list item format to enable
131+
automatic title rendering and improve readability. This ensures that GitHub
132+
automatically expands the reference to show the issue/PR title.
133133

134134
**Correct** — use a list item:
135135

@@ -212,8 +212,9 @@ PR names must be:
212212
| `fix(sdk): mute sound` | `Fix: add file to mute sound` | Technical details |
213213
| `test(api): open door` | `Feat: modified door function` | Vague, past tense |
214214

215-
A feature isn't a button, toggle, or handler — it's **what the user gains from
216-
it**. Ask _"What will users be able to do?"_ not _"What am I building?"_
215+
A feature isn't a button, toggle, or handler — it's
216+
**what the user gains from it**. Ask _"What will users be able to do?"_ not
217+
_"What am I building?"_
217218

218219
1. **Replace UI labels with actions**: Wrong: "Add dropdown for filters" →
219220
Correct: "Filter search results by category"
@@ -268,9 +269,11 @@ If there isn't an existing DESIGN.md file, create one and link it from README.md
268269

269270
Follow these steps in order from start to submission:
270271

271-
1. **Open a [draft PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests)**
272+
1. **Open a [draft
273+
PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests)**
272274
right away when you start working on a Problem.
273-
1. **[Link the PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)**
275+
1. **[Link the
276+
PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)**
274277
to the corresponding Problem issue using a closing keyword.
275278
1. **Assign yourself** so it is clear who is working on it.
276279
1. **Resolve all CI checks** — PRs with failing checks will be rejected.

0 commit comments

Comments
 (0)