Skip to content

Commit 09afcd8

Browse files
committed
Add documentation for triagebot [no-mentions] handler
1 parent 0e27843 commit 09afcd8

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
- [Mentions](./triagebot/mentions.md)
2727
- [Merge Conflicts](./triagebot/merge-conflicts.md)
2828
- [No Merge Policy](./triagebot/no-merge.md)
29+
- [No Mentions](./triagebot/no-mentions.md)
2930
- [Nominate](./triagebot/nominate.md)
3031
- [Note](./triagebot/note.md)
3132
- [Notifications](./triagebot/notifications.md)

src/triagebot/no-mentions.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# No Mentions (in commits)
2+
3+
GitHub permits having mentions (eg. `@user`) in commits, and while it's sometimes useful it's almost ended-up spamming the mentioned users, in particular as the commits are being rebased, cherry-picked or pushed.
4+
5+
This handler tries to prevent those mentions by adding a comment warning in the PR against them.
6+
7+
## Configuration
8+
9+
This feature is enabled on a repository by having a `[no-mentions]` table in `triagebot.toml`:
10+
11+
```toml
12+
[no-mentions]
13+
```
14+
15+
## Implementation
16+
17+
See [`src/handlers/check_commits/no_mentions.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/check_commits/no_mentions.rs).

0 commit comments

Comments
 (0)