feat: WIP current state of the project

Author: Entze

.github/workflows/prerelease.yaml.draft

@@ -0,0 +1,62 @@
+name: "prerelease"
+
+on:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "0.*"
+      - "*.*.*a*"
+      - "*.*.*b*"
+      - "*.*.*rc*"
+
+
+jobs:
+  build:
+    name: "📦 Build (Python ${{ matrix.python-version }}, ${{ matrix.os }})"
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version:
+          - '3.8'
+          - 'pypy-3.8'
+          - '3.9'
+          - 'pypy-3.9'
+          - '3.10'
+          - '3.11'
+        os: [ ubuntu-latest ]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - run: pipx install poetry
+      - run: poetry install --with ci --sync
+      - run: poetry run nox --session build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: "zipapp"
+          path: "pyggp-*${{ matrix.python-version }}"
+          if-no-files-found: error
+  sanity_check:
+    name: "🔬 Sanity Check (Python ${{ matrix.python-version }}, ${{ matrix.os }})"
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: [ '3.11' ]
+        os: [ ubuntu-22.04, ubuntu-20.04, macos-12, macos-11, windows-2022, windows-2019 ]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # TODO

docs/contributing/documenting.md

@@ -0,0 +1,71 @@
+# Documenting
+
+This document outlines how to consistently document the modules, classes, and functions in pyggp. It mostly follows
+the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html).
+
+## Modules
+
+Modules should have a docstring at the top of the file, which should be a short description of the module. A license
+boilerplate is *not* necessary.
+
+```python
+"""One line summary of the module, terminated by a period.
+
+Optionally more detail description of the module, but only one-line summary is fine as well. Additionally, an Examples
+section might be needed, but is not mandatory.
+
+Examples:
+    >>> import Foo
+    >>> Foo.bar()
+    'baz'
+
+"""
+```
+
+Test modules are not required to have a docstring.
+
+### Examples
+
+- A module containing exceptions that all end with `TreeError`:
+
+```python
+"""Exceptions regarding Trees."""
+```
+
+- A module that contains multiple classes all concerned with handling a specific type of data:
+
+```python
+"""Classes for trees.
+
+Provides classes for trees, including a base class for all trees, and a class for binary trees with optimizations
+applied.
+
+Examples:
+    >>> import Tree
+    >>> Tree.BinaryTree()
+    <BinaryTree>
+    >>> Tree.Tree()
+    <Tree>
+
+"""
+```
+
+- A module that contains a single class:
+
+```python
+"""Prime number sieve."""
+```
+
+- A module that contains functions:
+
+```python
+"""Functions for internationalization.
+
+Mostly for internal use when logging messages.
+
+"""
+```
+
+## Classes
+
+Classes should have a docstring at the top of the class definition, which should be a short description of the class.