You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add GrammarCheckTrigger that uses LanguageTool API for grammar and spelling checks
- Integrate trigger into main bot program alongside existing triggers
- Create comprehensive example documentation for usage
- Bot responds to issues with titles containing "grammar", "spell check", "proofread", etc.
- Posts detailed comments with error descriptions, context, and correction suggestions
- Supports real-time grammar checking using free LanguageTool public API
Fixes#81
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
This document demonstrates how to use the GitHub bot's grammar checking functionality.
4
+
5
+
## Overview
6
+
7
+
The bot includes a `GrammarCheckTrigger` that automatically checks issues for grammar and spelling errors using the LanguageTool API. When triggered, the bot will:
8
+
9
+
1. Analyze the issue description for grammar and spelling mistakes
10
+
2. Post a comment with suggested corrections
11
+
3. Provide context and replacement suggestions for each error found
12
+
13
+
## How to Trigger
14
+
15
+
The grammar checker will activate when you create an issue with a title containing any of these keywords:
16
+
- "grammar check"
17
+
- "spell check"
18
+
- "proofread"
19
+
- "grammar"
20
+
- "spelling"
21
+
22
+
## Example Usage
23
+
24
+
### Issue Title Examples
25
+
- "Grammar check please"
26
+
- "Can you proofread this text?"
27
+
- "Check spelling errors in this document"
28
+
- "Grammar and spelling review needed"
29
+
30
+
### Expected Bot Response
31
+
32
+
If the issue description contains text like:
33
+
```
34
+
This is a test with grammer mistakes and speling erors.
35
+
```
36
+
37
+
The bot will respond with:
38
+
```
39
+
## Grammar and Spelling Check Results
40
+
41
+
Found **3** potential issue(s):
42
+
43
+
**1.** Possible spelling mistake found.
44
+
- Context: "This is a test with **grammer** mistakes and speling erors."
45
+
- Suggested correction(s): grammar, grimmer, rammer, crammer, g rammer
46
+
47
+
**2.** Possible spelling mistake found.
48
+
- Context: "...his is a test with grammer mistakes and **speling** erors."
0 commit comments