Skip to content

Commit 3682f11

Browse files
authored
Merge pull request rails#42136 from jbampton/add-docs-on-misspell
Add documentation on spell checking with `misspell` [ci skip]
2 parents 722303b + 7c0341f commit 3682f11

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

guides/source/contributing_to_ruby_on_rails.md

+13
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,19 @@ Inspecting 1 file
275275

276276
For `rails-ujs` CoffeeScript and JavaScript files, you can run `npm run lint` in `actionview` folder.
277277

278+
We are also running [misspell](https://github.com/client9/misspell) which is mainly written in Golang to check
279+
spelling with [GitHub Actions](../../.github/workflows/lint.yml). Correct commonly misspelled English words quickly
280+
with `misspell`. You can run `misspell` locally against all files with:
281+
282+
```bash
283+
find . -type f | xargs ./misspell -i 'aircrafts,devels,invertions' -error
284+
```
285+
286+
Notable `misspell` help options or flags are:
287+
288+
- `-i` string: ignore the following corrections, comma separated
289+
- `-w`: Overwrite file with corrections (default is just to display)
290+
278291
### Benchmark Your Code
279292

280293
For changes that might have an impact on performance, please benchmark your

0 commit comments

Comments
 (0)