Merge branch 'main' into fix_typeguard

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+- repo: local
+  hooks:
+  - id: flake8
+    name: flake8
+    entry: flake8
+    language: system
+    types: [python]
+  - id: mypy
+    name: mypy
+    entry: mypy
+    language: system
+    types: [python]
+  - id: pytest
+    name: pytest
+    entry: coverage run -m pytest --typeguard-packages=strictly_typed_pandas,tests
+    language: system
+    types: [python]
+    pass_filenames: false

docs/source/contributing.rst

@@ -0,0 +1,29 @@
+============
+Contributing
+============
+
+We welcome contributions! To set up your development environment, we recommend using pyenv. You can find more on how to install ``pyenv`` and ``pyenv-virtualen`` here:
+
+* https://github.com/pyenv/pyenv
+* https://github.com/pyenv/pyenv-virtualenv
+
+To set up the environment, run:
+
+.. code-block:: bash
+
+    pyenv install 3.11
+    pyenv virtualenv 3.11 strictly_typed_pandas
+    pyenv activate strictly_typed_pandas
+    pip install -r requirements.txt
+    pip install -r requirements-dev.txt
+
+For a list of currently supported Python versions, we refer to ``.github/workflows/build.yml``.
+
+---------------
+Pre-commit hook
+---------------
+We use ``pre-commit`` to run a number of checks on the code before it is committed. To install the pre-commit hook, run:
+
+.. code-block:: bash
+
+    pre-commit install

docs/source/index.rst

@@ -12,3 +12,4 @@
    advanced
    deepdive_into_dtypes
    api
+   contributing

requirements-dev.txt

@@ -7,3 +7,4 @@ jupyter==1.0.0
 sphinx<=7.2.6
 sphinx_rtd_theme==1.3.0
 nbsphinx==0.9.3
+pre-commit==3.4.0