Skip to content

Commit 75481fe

Browse files
committed
update linting text
1 parent 0462907 commit 75481fe

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

{{cookiecutter.project_name}}/.github/next_steps/05_linting.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ title: 'Next step: Linting'
44

55
Your repository has a [workflow]({{ cookiecutter.repository }}/blob/main/.github/workflows/lint.yml) which [lints](https://en.wikipedia.org/wiki/Lint_(software)) your code after every push and when creating a pull request.
66

7-
To make sure you have a proper linter configuration you need to follow the steps below.
7+
Linter workflow may fail if `description` or `keywords` field in [setup.cfg]({{ cookiecutter.repository }}/blob/main/setup.cfg) is empty. Please update these fields. To validate your changes run:
88

9-
1. Update `description` and `keywords` fields in [setup.cfg]({{ cookiecutter.repository }}/blob/main/setup.cfg).
10-
1. Enable [githook](https://git-scm.com/docs/githooks) which will automatically lint your code in every commit. You can enable it by running the command below.
9+
```shell
10+
prospector
11+
```
1112

12-
```shell
13-
git config --local core.hooksPath .githooks
14-
```
13+
Enabling [githook](https://git-scm.com/docs/githooks) will automatically lint your code in every commit. You can enable it by running the command below.
14+
15+
```shell
16+
git config --local core.hooksPath .githooks
17+
```

0 commit comments

Comments
 (0)