Merge pull request #191 from CycloneDX/feat/pre-commit-hooks

[DEV] Add pre-commit hooks

Author: madpah

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+fail_fast: true
+repos:
+  - repo: local
+    hooks:
+      - id: system
+        name: mypy
+        entry: poetry run tox -e mypy
+        pass_filenames: false
+        language: system
+  - repo: local
+    hooks:
+      - id: system
+        name: isort
+        entry: poetry run isort .
+        pass_filenames: false
+        language: system
+  - repo: local
+    hooks:
+      - id: system
+        name: autopep8
+        entry: poetry run autopep8 --in-place -r cyclonedx tests
+        pass_filenames: false
+        language: system

CONTRIBUTING.md

@@ -23,7 +23,7 @@ Get it all applied via:
 
 ```shell
 poetry run isort .
-poetry run autopep8 --in-place -r .
+poetry run autopep8 --in-place -r cyclonedx tests
 ```
 
 ## Documentation
@@ -57,8 +57,20 @@ to show that you agree to publish your changes under the current terms and licen
 git commit --signed-off ...
 ```
 
+## Pre-commit hooks
+
+If you like to take advantage of [pre-commit hooks], you can do so to cover most of the topics on this page when
+contributing.
+
+```shell
+pre-commit install
+```
+
+All our pre-commit checks will run locally before you can commit!
+
 [poetry]: https://python-poetry.org
 [PEP8]: https://www.python.org/dev/peps/pep-0008
 [Sphinx]: https://www.sphinx-doc.org/
 [readthedocs.io]: https://cyclonedx-python-library.readthedocs.io/
 [RST]: https://en.wikipedia.org/wiki/ReStructuredText
+[pre-commit hooks]: https://pre-commit.com

docs/contributing.rst

@@ -0,0 +1,83 @@
+Contributing
+====================================================
+
+Pull requests are welcome, but please read these contributing guidelines first.
+
+Setup
+----------------------------------------------------
+
+This project uses `poetry`_. Have it installed and setup first.
+
+To install dev-dependencies and tools:
+
+.. code-block::
+
+   poetry install
+
+Code style
+----------------------------------------------------
+
+This project uses `PEP8`_ Style Guide for Python Code. This project loves sorted imports. Get it all applied via:
+
+.. code-block::
+
+    poetry run isort .
+    poetry run autopep8 --in-place -r cyclonedx tests
+
+
+Documentation
+----------------------------------------------------
+
+This project uses `Sphinx`_ to generate documentation which is automatically published to `readthedocs.io`_.
+
+Source for documentation is stored in the ``docs`` folder in `RST`_ format.
+
+You can generate the documentation locally by running:
+
+.. code-block::
+
+    cd docs
+    pip install -r requirements.txt
+    make html
+
+
+Testing
+----------------------------------------------------
+
+Run all tests in dedicated environments, via:
+
+.. code-block::
+
+    poetry run tox
+
+
+Sign your commits
+----------------------------------------------------
+
+Please sign your commits, to show that you agree to publish your changes under the current terms and licenses of the
+project. We can't accept contributions, however great, if you do not sign your commits.
+
+.. code-block::
+
+    git commit --signed-off ...
+
+
+Pre-commit hooks
+----------------------------------------------------
+
+If you like to take advantage of `pre-commit hooks`_, you can do so to cover most of the topics on this page when
+contributing.
+
+.. code-block::
+
+    pre-commit install
+
+All our pre-commit checks will run locally before you can commit!
+
+
+.. _poetry: https://python-poetry.org
+.. _PEP8: https://www.python.org/dev/peps/pep-0008
+.. _Sphinx: https://www.sphinx-doc.org/
+.. _readthedocs.io: https://cyclonedx-python-library.readthedocs.io/
+.. _RST: https://en.wikipedia.org/wiki/ReStructuredText
+.. _pre-commit hooks: https://pre-commit.com

docs/index.rst

@@ -37,6 +37,7 @@ programmatically generate SBOMs.
 
    install
    architecture
+   contributing
    support
    changelog