Merge branch 'main' into dev

.pre-commit-config.yaml

@@ -25,13 +25,13 @@ repos:
     -   id: check-toml
     -   id: debug-statements
     -   id: name-tests-test
--   repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.11.0
+-   repo: https://github.com/psf/black
+    rev: 23.12.1
     hooks:
       - id: black
         language_version: python3.8
 -   repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
     -   id: flake8
         additional_dependencies: [flake8-typing-imports==1.12.0]
@@ -47,12 +47,12 @@ repos:
     -   id: pyupgrade
         args: [--py36-plus, --keep-runtime-typing]
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.7.0'
+    rev: 'v1.8.0'
     hooks:
     -   id: mypy
         args: [--disallow-untyped-defs, --disallow-incomplete-defs, --disallow-untyped-calls]
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.1.5
+  rev: v0.1.11
   hooks:
     - id: ruff # runs faster than pylint
       args: [--fix, --exit-non-zero-on-fix]

README.md

@@ -106,4 +106,4 @@ If you contribute to the project, you agree to share your contribution following
 
 Please [cite](docs/_static/colrev_citation.bib) the project as follows:
 
-Wagner, G. and Prester, J. (2023) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev.
+Wagner, G. and Prester, J. (2024) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev.

docs/source/dev_docs/setup/macos_vm.rst

@@ -3,6 +3,8 @@ MacOS: VirtualBox
 
 NOTE: VirtualBox does not have official support for macOS with Apple Silicon M1/M2. Please use developer preview versions of VirtualBox at your own discretion. It may be necessary to identify the specific version of VirtualBox that is compatible with the Mac version.
 
+**It is recommended to create a backup of your machine (using Time Machine) before setting up virtualBox.**
+
 A fully installed VirtualBox image is available `here <https://gigamove.rwth-aachen.de/en/download/a0dc5c130b24636165a5772921ebff40>`__.
 If the link has expired, please contact `Gerit Wagner <mailto:[email protected]>`__.
 

docs/source/foundations/cep.rst

@@ -3,7 +3,7 @@ CoLRev enhancement proposals (CEPs)
 
 CEP stands for CoLRev Enhancement Proposal.
 A CEP is a design document providing information to the CoLRev community, or describing a new feature for CoLRev or its processes or environment.
-The CEP should provide a concise technical specification of the feature and a rationale for the feature (inspired by `PEP, Python Enhancment Propsals <https://peps.python.org/pep-0001/>`_).
+The CEP should provide a concise technical specification of the feature and a rationale for the feature (inspired by `PEP, Python Enhancment Propsals <https://peps.python.org/pep-0001/>`_ and `Jabref architectural decision records (ADR) <https://devdocs.jabref.org/decisions/>`_).
 
 **Draft CEPs**