Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
M
mruby
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
mruby
Commits
7893cbb5
Unverified
Commit
7893cbb5
authored
Jun 16, 2021
by
Yukihiro "Matz" Matsumoto
Committed by
GitHub
Jun 16, 2021
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #5444 from jbampton/add-misspell-docs
Add documentation on spell checking with misspell
parents
2341e4f5
f4d9a9be
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
0 deletions
+15
-0
CONTRIBUTING.md
CONTRIBUTING.md
+15
-0
No files found.
CONTRIBUTING.md
View file @
7893cbb5
...
...
@@ -37,6 +37,21 @@ To update use `pre-commit autoupdate`
*
[
Usage
](
https://pre-commit.com/#usage
)
*
[
pre-commit-autoupdate
](
https://pre-commit.com/#pre-commit-autoupdate
)
## Spell Checking
We are 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
-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)
## Coding conventions
How to style your C and Ruby code which you want to submit.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment