Merge pull request #257 from NLeSC/238-linting-template

Linting issues template

Author: fdiblen

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

@@ -2,4 +2,16 @@
 title: 'Next step: Linting'
 ---
 
-Linting instructions
+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.
+
+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:
+
+```shell
+prospector
+```
+
+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.
+
+```shell
+git config --local core.hooksPath .githooks
+```

{{cookiecutter.project_name}}/{{cookiecutter.package_name}}/my_module.py

@@ -1,5 +1,6 @@
 """Documentation about the {{ cookiecutter.package_name }} module."""
 
 # FIXME: put actual code here
+
 def hello(name):
-  return f'Hello {name}!'
+    return f'Hello {name}!'