Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Add solution for markdown-lint installation issue #497

Merged
merged 3 commits into from
Jan 16, 2021
Merged

[Docs] Add solution for markdown-lint installation issue #497

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3a380d
add solution for markdown-lint issue
dreamerlin Dec 28, 2020
0a5bf1f
add setup
dreamerlin Jan 15, 2021
2a489c1
simplify ruby install
dreamerlin Jan 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,21 @@ 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 the following stpes

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

# set up environment
echo 'source $HOME/.bash_profile' >> ~/.bashrc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line is not friendly

source ~/.profile
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

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