diff options
| author | John Bampton <[email protected]> | 2021-07-07 22:26:19 +1000 |
|---|---|---|
| committer | John Bampton <[email protected]> | 2021-07-07 22:26:19 +1000 |
| commit | c9db3ec7c3cf41189d420cba0caa4ed67b10f727 (patch) | |
| tree | 30e248a3ca88c10e784867b8d2af0fcf8dba4028 /CONTRIBUTING.md | |
| parent | 17748ecd1ae31f755e131c841be5cb06064e7a7a (diff) | |
| download | mruby-c9db3ec7c3cf41189d420cba0caa4ed67b10f727.tar.gz mruby-c9db3ec7c3cf41189d420cba0caa4ed67b10f727.zip | |
Style the CONTRIBUTING guide
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab0ae11f5..516be1e3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,15 +18,15 @@ things in mind before submitting your pull request: * Use mrbgem to provide non ISO features (classes, modules and methods) unless you have a special reason to implement them in the core -## Pre-commit +## pre-commit -A framework for managing and maintaining multi-language pre-commit hooks. -Pre-commit can be [installed](https://pre-commit.com/#installation) with `pip`, `curl`, `brew` or `conda`. +A framework for managing and maintaining multi-language `pre-commit` hooks. +`pre-commit` can be [installed](https://pre-commit.com/#installation) with `pip`, `curl`, `brew` or `conda`. -You need to first install pre-commit and then install the pre-commit hooks with `pre-commit install`. -Now pre-commit will run automatically on git commit! +You need to first install `pre-commit` and then install the `pre-commit` hooks with `pre-commit install`. +Now `pre-commit` will run automatically on git commit! -It's usually a good idea to run the hooks against all the files when adding new hooks (usually pre-commit will only run on the changed files during git hooks). +It's usually a good idea to run the hooks against all the files when adding new hooks (usually `pre-commit` will only run on the changed files during git hooks). Use `pre-commit run --all-files` to check all files. To run a single hook use `pre-commit run --all-files <hook_id>` @@ -39,9 +39,10 @@ To update use `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: +We are running [misspell](https://github.com/client9/misspell) which is mainly written in +[Golang](https://golang.org/) 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 |