Skip to content

Commit ff373f4

Browse files
committedMar 21, 2023
docs: Minor README improvements
1 parent 3da6b20 commit ff373f4

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed
 

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a GitHub Action that ensures your PR title matches the [Conventional Commits spec](https://www.conventionalcommits.org/). The typical use case is to use this in combination with a tool like [semantic-release](https://github.com/semantic-release/semantic-release) to automate releases.
44

5-
Used by: [Apache](https://github.com/apache/pulsar) · [Vercel](https://github.com/vercel/ncc) · [Microsoft](https://github.com/microsoft/SynapseML) · [Firebase](https://github.com/firebase/flutterfire) · [AWS](https://github.com/aws-ia/terraform-aws-eks-blueprints) · [Electron](https://github.com/electron/forge) – and many more.
5+
Used by: [Apache](https://github.com/apache/pulsar) · [Vercel](https://github.com/vercel/ncc) · [Microsoft](https://github.com/microsoft/SynapseML) · [Firebase](https://github.com/firebase/flutterfire) · [AWS](https://github.com/aws-ia/terraform-aws-eks-blueprints) · [Electron](https://github.com/electron/forge) – and [many more](https://github.com/amannn/action-semantic-pull-request/network/dependents).
66

77
## Examples
88

@@ -12,14 +12,14 @@ Used by: [Apache](https://github.com/apache/pulsar) · [Vercel](https://github.c
1212
- refactor!: Drop support for Node.js 12
1313
- feat(ui): Add `Button` component
1414

15-
Note that since PR titles only have a single line, you have to use `!` to indicate breaking changes.
15+
> Note that since PR titles only have a single line, you have to use `!` to indicate breaking changes.
1616
1717
See [Conventional Commits](https://www.conventionalcommits.org/) for more examples.
1818

1919
## Installation
2020

2121
1. If your goal is to create squashed commits that will be used for automated releases, you'll want to configure your GitHub repository to [use the squash & merge strategy](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests) and tick the option "Default to PR title for squash merge commits".
22-
2. [Add the action](https://docs.github.com/en/actions/quickstart) with the following configuration
22+
2. [Add the action](https://docs.github.com/en/actions/quickstart) with the following configuration:
2323
```yml
2424
name: "Lint PR"
2525

0 commit comments

Comments
 (0)
Please sign in to comment.