Skip to content

Commit 4c94da8

Browse files
Merge pull request #431 from adamtheturtle/combine-lint
Combine lint
2 parents 8bce20a + 07a2faa commit 4c94da8

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

.travis.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ install:
4949
cache: pip
5050
before_script:
5151
- make lint
52-
- markdownlint --config .markdownlint.json README.md CONTRIBUTING.md
5352
- python ci/set_secrets_file.py
5453
script:
5554
- pytest --exitfirst -vvv tests/mock_vws/"$TEST_FILENAME" --cov=src --cov=tests

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ Travis CI is the canonical source truth.
66

77
## Install Contribution Dependencies
88

9-
Install dependencies in a virtual environment.
9+
Install Python dependencies in a virtual environment.
1010

1111
```sh
1212
pip install --editable .[dev]
1313
```
1414

15+
Insall `npm` dependencies for linting Markdown files:
16+
17+
```
18+
npm install -g markdownlint-cli
19+
```
20+
1521
Spell checking requires `enchant`.
1622
This can be installed on macOS, for example, with [Homebrew](http://brew.sh):
1723

@@ -25,6 +31,8 @@ and on Ubuntu with `apt`:
2531
apt-get install -y enchant
2632
```
2733

34+
and to lint
35+
2836
## Linting
2937

3038
Run lint tools:

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ lint:
1414
pyroma .
1515
vulture . --min-confidence 100
1616
yapf --diff --recursive src/ tests/ ci/
17+
markdownlint --config .markdownlint.json README.md CONTRIBUTING.md
1718

1819
fix-lint:
1920
autoflake --in-place --recursive --remove-all-unused-imports --remove-unused-variables .

0 commit comments

Comments
 (0)