diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..68fd7028ce --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +exclude: '^$' +fail_fast: false +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.2.3 + hooks: + - id: flake8 + additional_dependencies: [flake8-docstrings, flake8-debugger, flake8-bugbear] diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0d030bfa09..5e661b0c80 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -106,6 +106,17 @@ After talking to the Satpy developers any additional work like code or documentation changes can be provided as a GitHub `Pull Request `_. +To make sure that your code complies with the pytroll python standard, you can +run the `flake8 `_ linter on your changes +before you submit them, or even better install a pre-commit hook that runs the +style check for you. To this aim, we provide a configuration file for the +`pre-commit `_ tool, that you can install with eg:: + + pip install pre-commit + pre-commit install + +running from your base satpy directory. This will automatically check code style for every commit. + Code of Conduct ===============