You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: {{cookiecutter.project_name}}/.github/next_steps/05_linting.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,14 @@ title: 'Next step: Linting'
4
4
5
5
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.
6
6
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:
8
8
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
+
```
11
12
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.
0 commit comments