diff options
| author | John Bampton <[email protected]> | 2021-03-01 10:06:17 +1000 |
|---|---|---|
| committer | John Bampton <[email protected]> | 2021-03-01 10:06:17 +1000 |
| commit | 1c9b1bfeb7932c1b82509679e40b2d2bf99768cc (patch) | |
| tree | 3868be98b373b479ab17173b2cb6a5c6ab095c57 /CONTRIBUTING.md | |
| parent | 65add8c650088f398642aa9611baf4cb2266fff4 (diff) | |
| download | mruby-1c9b1bfeb7932c1b82509679e40b2d2bf99768cc.tar.gz mruby-1c9b1bfeb7932c1b82509679e40b2d2bf99768cc.zip | |
feat: add pre-commit framework
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ffd759b1..7e48508aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +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 + +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! +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. + ## Coding conventions How to style your C and Ruby code which you want to submit. |