Skip to content

Commit

Permalink
fix: examples should follow Conventional Commits conventions
Browse files Browse the repository at this point in the history
Also in English, most of the time you don't write a capital letter after colon
  • Loading branch information
tkrotoff committed Apr 3, 2024
1 parent 67cbd7a commit 90bd769
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Used by: [Electron](https://github.com/electron/electron) · [Vite](https://gith
## Examples

**Valid pull request titles:**
- fix: Correct typo
- feat: Add support for Node.js 18
- refactor!: Drop support for Node.js 12
- feat(ui): Add `Button` component
- fix: correct typo
- feat: add support for Node.js 18
- refactor!: drop support for Node.js 12
- feat(ui): add `Button` component

> Note that since pull request titles only have a single line, you have to use `!` to indicate breaking changes.
Expand Down Expand Up @@ -117,7 +117,7 @@ For work-in-progress PRs you can typically use [draft pull requests from GitHub]
**Example:**
```
[WIP] feat: Add support for Node.js 18
[WIP] feat: add support for Node.js 18
```
This will prevent the PR title from being validated, and pull request checks will remain pending.
Expand Down

0 comments on commit 90bd769

Please sign in to comment.