Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
### Scoping

> [!TIP]
> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on software design philosophy.

Check warning on line 190 in docs/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / checks

MD013

Paragraph could be normalized to use line length of 80 characters

When planning the scope of work, make sure you
[keep PRs small](https://artsy.github.io/blog/2021/03/09/strategies-for-small-focused-pull-requests/).
Expand Down Expand Up @@ -231,6 +231,16 @@
Correct: "Gracefully recover from connection errors"
1. **Use user action verbs**: _View, Play, Customize, Save_, etc.

> [!WARNING]
> This rule applies to **all PR types**, including `docs`. Do not use verbs that
> describe what you did ("document", "update", "add") — use verbs that describe
> what users can now do.
>
> | **Good** ✅ | **Bad** ❌ |
> | -------------------------------------------------- | --------------------------------------------------- |
> | `docs(typefully): log in with shared account` | `docs(typefully): document shared account` |
> | `docs(api): authenticate with OAuth` | `docs(api): add OAuth section to README` |

#### Before Submitting, Ask

1. Does it use `type(scope [Optional]): action` format?
Expand All @@ -240,7 +250,7 @@

#### Design PRs

Design PRs use `docs(ui)` as the type and scope. e.g.: `docs(ui): design table component`

Check warning on line 253 in docs/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / checks

MD013

Paragraph could be normalized to use line length of 80 characters

Initiate a PR with a note in the DESIGN.md file detailing the addressed design
aspects. Structure the design file with the following markup:
Expand Down Expand Up @@ -272,7 +282,7 @@
- [[Bid Popup]](https://figma.com/your-design-file-url)
```

If there isn't an existing DESIGN.md file, create one and link it from README.md.

Check warning on line 285 in docs/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / checks

MD013

Paragraph could be normalized to use line length of 80 characters

### PR Lifecycle

Expand Down
Loading