kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Add documentation on spell checking with misspell [ci skip]

Browse source
This commit is contained in:
John Bampton 2021-05-04 07:08:48 +10:00
parent 722303b4a7
commit 7c0341fbdc
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
guides/source/contributing_to_ruby_on_rails.md
View file

@ -275,6 +275,19 @@ Inspecting 1 file
For `rails-ujs` CoffeeScript and JavaScript files, you can run `npm run lint` in `actionview` folder.
We are also running [misspell](https://github.com/client9/misspell) which is mainly written in Golang to check
spelling with [GitHub Actions](../../.github/workflows/lint.yml). Correct commonly misspelled English words quickly
with `misspell`. You can run `misspell` locally against all files with:
```bash
find . -type f | xargs ./misspell -i 'aircrafts,devels,invertions' -error
```
Notable `misspell` help options or flags are:
- `-i` string: ignore the following corrections, comma separated
- `-w`: Overwrite file with corrections (default is just to display)
### Benchmark Your Code
For changes that might have an impact on performance, please benchmark your