Skip to content

Commit db15821

Browse files
senthil4321Copilot
andauthored
Copilot/fix a3a62f07 31b8 4576 b357 ea613ebeea95 (#6)
* Initial plan * Initial analysis and plan for automatic spell check on PRs Co-authored-by: senthil4321 <44191007+senthil4321@users.noreply.github.com> * Add automatic spell check workflow for pull requests Co-authored-by: senthil4321 <44191007+senthil4321@users.noreply.github.com> * Final verification and documentation of spell check automation Co-authored-by: senthil4321 <44191007+senthil4321@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 56eaa1e commit db15821

File tree

4 files changed

+91
-1
lines changed

4 files changed

+91
-1
lines changed

.github/workflows/spell-check.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
branches: [ master, main ]
6+
paths:
7+
- '**.md'
8+
- '**.txt'
9+
- 'spell_check.py'
10+
11+
jobs:
12+
spell-check:
13+
name: Check Spelling
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Set up Python
21+
uses: actions/setup-python@v4
22+
with:
23+
python-version: '3.x'
24+
25+
- name: Install aspell
26+
run: |
27+
sudo apt-get update
28+
sudo apt-get install -y aspell aspell-en
29+
30+
- name: Run spell checker
31+
run: |
32+
echo "Running spell check on documentation files..."
33+
if python3 spell_check.py; then
34+
echo "✅ Spell check passed - no errors found!"
35+
else
36+
echo "❌ Spell check failed - errors found in documentation"
37+
echo "Check the generated SPELLING_REPORT.md for details"
38+
exit 1
39+
fi
40+
41+
- name: Upload spelling report
42+
if: failure()
43+
uses: actions/upload-artifact@v4
44+
with:
45+
name: spelling-report
46+
path: SPELLING_REPORT.md
47+
retention-days: 30

.gitignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Temporary files
2+
*.tmp
3+
*.temp
4+
.DS_Store
5+
Thumbs.db
6+
7+
# Python
8+
__pycache__/
9+
*.pyc
10+
*.pyo
11+
*.pyd
12+
.Python
13+
14+
# IDE files
15+
.vscode/
16+
.idea/
17+
*.swp
18+
*.swo
19+
20+
# Build artifacts
21+
build/
22+
dist/
23+
*.egg-info/
24+
25+
# Logs
26+
*.log
27+
28+
# OS generated files
29+
.DS_Store
30+
.DS_Store?
31+
._*
32+
.Spotlight-V100
33+
.Trashes
34+
ehthumbs.db
35+
Thumbs.db

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Help
22

3+
[![Spell Check](https://github.com/senthil4321/help/actions/workflows/spell-check.yml/badge.svg)](https://github.com/senthil4321/help/actions/workflows/spell-check.yml)
4+
35
This repository contains commonly used command and help information for day to day programming and documentation
6+
7+
## Spell Check
8+
9+
All `.md` and `.txt` files are automatically checked for spelling errors on pull requests. PRs will be rejected if spelling errors are found. See [SPELL_CHECK_README.md](SPELL_CHECK_README.md) for details about the spell checking system.
10+
411
## Documentation
512
Autodidactic
613

SPELLING_REPORT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Spelling Error Report
22

3+
34
Generated on: Tue Sep 2 20:45:00 UTC 2025
45

56
## Summary
@@ -323,7 +324,7 @@ ABCDEFGHIJKLMNOPQRSTUVWXYZ
323324

324325
**1 error(s) found:**
325326

326-
**Line 5:**
327+
**Line 12:**
327328
```
328329
Autodidactic
329330
```

0 commit comments

Comments
 (0)