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

Commit 9fe3c82

Browse files
committed
chore: add comment screenshot
1 parent 4d8e591 commit 9fe3c82

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,5 @@ typings/
5656

5757
# dotenv environment variables file
5858
.env
59+
60+
.vscode/launch.json

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,23 @@ On the next pull request, a status check from `commitlint-bot` will appear:
2323

2424
![status-check-screenshot][]
2525

26+
Problem details will be reported as a comment like this:
27+
28+
![status-comment-screenshot][]
29+
30+
2631
For best results, enable branch protection (in the repository's settings) and require the `commitlint-bot` status check to pass before merging:
2732

2833
![branch-protection-screenshot][]
2934

3035
[apps]: https://github.com/apps/commitlint-bot
3136
[status-check-screenshot]: docs/status.png
37+
[status-comment-screenshot]: docs/comment.png
3238
[branch-protection-screenshot]: docs/setting.png
3339

34-
## Todo
40+
## What is missing?
3541

36-
- [ ] Add tests
37-
- [ ] Support `.commitlintrc.json` and `.commitlintrc.yml` files
38-
- [ ] Add here ? open an [issue](https://github.com/ahmed-taj/commitlint-bot/issues/new)
42+
We don't currently support custom configuration (i.e. `.commitlint.yml` or `.commitlint.json`), but [we will]()
3943

4044
## Development
4145

docs/comment.png

18.5 KB
Loading

0 commit comments

Comments
 (0)