QA

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+ignore = E203, E266, W503, F403, F401
+max-line-length = 88
+max-complexity = 18
+select = B,C,E,F,W,T4,B9

.github/workflows/quality.yml

@@ -0,0 +1,29 @@
+name: Quality
+on:
+  pull_request:
+    branches: [ "main" ]
+  workflow_call:
+permissions:
+  contents: read
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'true'
+    - name: Install poetry
+      run: pipx install poetry
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+        cache: 'poetry'
+    - name: Install dependencies
+      run: poetry install --with dev
+    - name: Lint with flake8
+      run: |
+        poetry run flake8 src
+        poetry run flake8 tests
+    - name: Running license check
+      run: poetry run licensecheck --zero --license mit --ignore-packages trackml qallse

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+    - id: black
+      # language_version: python3.10
+# -   repo: https://github.com/PyCQA/flake8
+#     rev: 6.0.0
+#     hooks:
+#     - id: flake8

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to From Hope to Heuristics
+
+Contributions are highly welcome! :hugging_face:
+
+Start of by..
+1. Creating an issue using one of the templates (Bug Report, Feature Request)
+   - let's discuss what's going wrong or what should be added
+   - can you contribute with code? Great! Go ahead! :rocket: 
+2. Forking the repository and working on your stuff. See the sections below for details on how to set things up.
+3. Creating a pull request to the main repository
+
+## Setup
+
+Contributing to this project requires some more dependencies besides the "standard" packages.
+Those are specified in the groups `dev` and `docs`.
+```
+poetry install --with dev,docs
+```
+
+Additionally, we have pre-commit hooks in place, which can be installed as follows: 
+```
+poetry run pre-commit autoupdate
+poetry run pre-commit install
+```
+
+Currently the only purpose of the hook is to run Black on commit which will do some code formatting for you.
+However be aware, that this might reject your commit and you have to re-do the commit.
+
+## Testing
+
+We do our testing with Pytest. Corresponding tests can be triggered as follows:
+```
+poetry run pytest
+```
+There are Github action pipelines in place, that will do linting and testing once you open a pull request.
+However, it's a good idea to run tests and linting (either Black or Flake8) locally before pushing.
+
+## Documentation
+
+We use MkDocs for our documentation. To run a server locally, run:
+```
+poetry run mkdocs serve
+```
+This will automatically trigger a rebuild each time you make changes.
+See the [MkDocs Documentation](https://cirkiters.github.io/qml-essentials/usage/) for more details.
+
+Publishing (and building) the documentation is done automagically using Github actions.
+This action is triggered when a new release is made.

README.md

@@ -63,3 +63,7 @@ The following list gives a brief explanation of the most important locations in
 Besides that, we make use of two submodules:
 - `hepqpr-qallse`: Currently, all the data loading and QUBO formulation is done using this submodule
 - `trackml-library`: Not in use currently
+
+## 🚧 Contributing
+
+Contributions are highly welcome! Take a look at our [Contribution Guidelines](https://github.com/cirKITers/qml-essentials/blob/main/CONTRIBUTING.md).