openstack-doc-tools/doc/source
Hervé Beraud fbe3f2fe7c Adding pre-commit
Introduced changes:
- pre-commit config and rules
- Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks.
- Applying fixes for pre-commit compliance in all code.

Also commit hash will be used instead of version tags in pre-commit to
prevend arbitrary code from running in developer's machines.

pre-commit will be used to:
- trailing whitespace;
- Replaces or checks mixed line ending (mixed-line-ending);
- Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker);
- Checks that non-binary executables have a proper
  shebang (check-executables-have-shebangs);
- Check for files that contain merge conflict strings (check-merge-conflict);
- Check for debugger imports and py37+ breakpoint()
  calls in python source (debug-statements);
- Attempts to load all yaml files to verify syntax (check-yaml);
- Run flake8 checks (flake8) (local)

For further details about tests please refer to:
https://github.com/pre-commit/pre-commit-hooks

Change-Id: I7ac1599e903577e28fb64bb07a6b984e1ff8a023
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-09-15 15:05:13 +02:00
..
man Publish to publish-docs/html 2019-08-15 06:30:48 +02:00
conf.py Adding pre-commit 2020-09-15 15:05:13 +02:00
doc-tools-readme.rst Update sitemap tests 2017-04-29 10:36:27 +10:00
index.rst Remove 'autogenerate_config_docs' 2017-10-04 11:47:56 +01:00
installation.rst Update docs building 2019-08-11 09:48:06 +02:00
release_notes.rst Update sitemap tests 2017-04-29 10:36:27 +10:00
sitemap-readme.rst Update sitemap tests 2017-04-29 10:36:27 +10:00
usage.rst Update docs building 2019-08-11 09:48:06 +02:00