Skip to content

Commit

Permalink
[Docs] Add solution for markdown-lint installation issue (open-mmlab#497
Browse files Browse the repository at this point in the history
)

* add solution for markdown-lint issue

* add setup

* simplify ruby install
  • Loading branch information
dreamerlin authored Jan 16, 2021
1 parent feb99e1 commit a6da544
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,20 @@ From the repository folder
pre-commit install
```

If you are facing an issue when installing markdown lint, you may install ruby for markdown lint by
referring to [this repo](https://github.com/innerlee/setup) by following the usage and taking [`zzruby.sh`](https://github.com/innerlee/setup/blob/master/zzruby.sh)

or by the following steps

```shell
# install rvm
curl -L https://get.rvm.io | bash -s -- --autolibs=read-fail
rvm autolibs disable

# install ruby
rvm install 2.7.1
```

After this on every commit check code linters and formatter will be enforced.

>Before you create a PR, make sure that your code lints and is formatted by yapf.
Expand Down

0 comments on commit a6da544

Please sign in to comment.