Skip to content
This repository was archived by the owner on Apr 1, 2020. It is now read-only.

Commit 7c00e2d

Browse files
committed
chore: remove "bot" suffix
Probot strongly recommend against having the name bot in the title of a GitHub App. One of the reasons for this is that your app is already labeled a bot by GitHub, so if it comments, it will show up as commitlint-bot[bot].
1 parent 6dd5a77 commit 7c00e2d

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010

1111
<p align="center">
12-
<img src="docs/robot.svg" width="256" alt="commitlint-bot logo" />
12+
<img src="docs/robot.svg" width="256" alt="commitlint logo" />
1313
</p>
1414

1515
> Built with [probot](https://github.com/probot/probot) framework
@@ -19,11 +19,11 @@ and sets an appropriate status check.
1919

2020
## Usage
2121

22-
1. Browse to [GitHub Apps - commitlint-bot][apps]
22+
1. Browse to [GitHub Apps - commitlint][apps]
2323
2. Accept the permissions
2424
3. Allow access to repositories
2525

26-
On the next pull request, a status check from `commitlint-bot` will appear:
26+
On the next pull request, a status check from `commitlint` will appear:
2727

2828
![status-check-screenshot][]
2929

@@ -32,11 +32,11 @@ Problem details will be reported as a comment like this:
3232
![status-comment-screenshot][]
3333

3434

35-
For best results, enable branch protection (in the repository's settings) and require the `commitlint-bot` status check to pass before merging:
35+
For best results, enable branch protection (in the repository's settings) and require the `commitlint` status check to pass before merging:
3636

3737
![branch-protection-screenshot][]
3838

39-
[apps]: https://github.com/apps/commitlint-bot
39+
[apps]: https://github.com/apps/commitlint
4040
[status-check-screenshot]: docs/status.png
4141
[status-comment-screenshot]: docs/comment.png
4242
[branch-protection-screenshot]: docs/setting.png

docs/comment.png

1.46 KB
Loading

docs/setting.png

7.01 KB
Loading

docs/status.png

2.33 KB
Loading

lib/lint.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const commitlint = async ({ github, payload }) => {
1818
sha: payload.pull_request.head.sha,
1919
repo: name,
2020
owner: owner.login,
21-
context: 'commitlint-bot'
21+
context: 'commitlint'
2222
}
2323

2424
// Pending

test/bot.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const baseStatus = {
1212
sha: '123456789',
1313
repo: 'repo',
1414
owner: 'user',
15-
context: 'commitlint-bot'
15+
context: 'commitlint'
1616
}
1717

1818
describe('commitlint-bot', () => {

0 commit comments

Comments
 (0)