docs: refer to compwa-org for contributing (#137)

* ci: upgrade pinned requirements * ci: update pin_requirements script ComPWA/policy@70e1239 Co-authored-by: GitHub <noreply@github.com>
ComPWA · Aug 30, 2021 · b6c8f8b · b6c8f8b
1 parent 628d1ee
commit b6c8f8b
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 69 deletions.
diff --git a/.constraints/pin_requirements.py b/.constraints/pin_requirements.py
@@ -15,7 +15,7 @@
 OUTPUT_FILE = f"{CONSTRAINTS_DIR}/py{PYTHON_VERSION}.txt"
 
 
-def upgrade_constraints_file() -> None:
+def upgrade_constraints_file() -> int:
     os.makedirs(CONSTRAINTS_DIR, exist_ok=True)
     pip_compile_command = " ".join(
         [
@@ -28,7 +28,7 @@ def upgrade_constraints_file() -> None:
     )
     print("Running the following command:")
     print(f"   {pip_compile_command}")
-    subprocess.call(pip_compile_command, shell=True)
+    return subprocess.call(pip_compile_command, shell=True)
 
 
 def remove_extras_syntax() -> None:
@@ -68,5 +68,6 @@ def perform_replacements(line: str) -> str:
 
 
 if "__main__" in __name__:
-    upgrade_constraints_file()
+    if upgrade_constraints_file():
+        raise RuntimeError("There were issues running pip-compile")
     remove_extras_syntax()
diff --git a/.constraints/py3.6.txt b/.constraints/py3.6.txt
@@ -6,21 +6,20 @@
 #
 alabaster==0.7.12
 anyio==3.3.0
-appdirs==1.4.4
 aquirdturtle-collapsible-headings==3.1.0
-argon2-cffi==20.1.0
+argon2-cffi==21.1.0
 astroid==2.7.2
 async-generator==1.10
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
 backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
-black==21.7b0
-bleach==4.0.0
+black==21.8b0
+bleach==4.1.0
 certifi==2021.5.30
 cffi==1.14.6
-cfgv==3.3.0
+cfgv==3.3.1
 charset-normalizer==2.0.4
 click==8.0.1
 colorama==0.4.4
@@ -57,7 +56,7 @@ identify==2.2.13
 idna==3.2
 imagesize==1.2.0
 immutables==0.16
-importlib-metadata==4.6.4
+importlib-metadata==4.8.1
 importlib-resources==3.0.0
 iniconfig==1.1.1
 ipykernel==5.5.5
@@ -76,7 +75,7 @@ jupyter-core==4.7.1
 jupyter-server==1.10.2
 jupyter-server-mathjax==0.2.3
 jupyter-sphinx==0.3.2
-jupyterlab==3.1.8
+jupyterlab==3.1.9
 jupyterlab-code-formatter==1.4.10
 jupyterlab-server==2.7.2
 jupyterlab-widgets==1.0.0
@@ -119,7 +118,7 @@ pillow==8.3.1
 pip-tools==6.2.0
 platformdirs==2.2.0
 pluggy==0.13.1
-pre-commit==2.14.0
+pre-commit==2.14.1
 prometheus-client==0.11.0
 prompt-toolkit==3.0.20
 ptyprocess==0.7.0
@@ -148,11 +147,11 @@ pyyaml==5.4.1
 pyzmq==22.2.1
 qrules==0.9.1
 radon==5.1.0
-regex==2021.8.21
+regex==2021.8.28
 requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
-rich==10.7.0
+rich==10.9.0
 send2trash==1.8.0
 six==1.16.0
 smmap==4.0.0
@@ -186,7 +185,7 @@ tqdm==4.62.2
 traitlets==4.3.3
 typed-ast==1.4.3
 types-docutils==0.17.0
-typing-extensions==3.10.0.0 ; python_version < "3.8.0"
+typing-extensions==3.10.0.1 ; python_version < "3.8.0"
 urllib3==1.26.6
 virtualenv==20.7.2
 wcwidth==0.2.5

diff --git a/.constraints/py3.7.txt b/.constraints/py3.7.txt
@@ -6,21 +6,20 @@
 #
 alabaster==0.7.12
 anyio==3.3.0
-appdirs==1.4.4
 aquirdturtle-collapsible-headings==3.1.0
 argcomplete==1.12.3
-argon2-cffi==20.1.0
+argon2-cffi==21.1.0
 astroid==2.7.2
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
 backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
-black==21.7b0
-bleach==4.0.0
+black==21.8b0
+bleach==4.1.0
 certifi==2021.5.30
 cffi==1.14.6
-cfgv==3.3.0
+cfgv==3.3.1
 charset-normalizer==2.0.4
 click==8.0.1
 colorama==0.4.4
@@ -55,12 +54,12 @@ hepunits==2.1.1
 identify==2.2.13
 idna==3.2
 imagesize==1.2.0
-importlib-metadata==4.6.4
+importlib-metadata==4.8.1
 importlib-resources==5.2.2
 iniconfig==1.1.1
 ipykernel==6.2.0
 ipympl==0.7.0
-ipython==7.26.0
+ipython==7.27.0
 ipython-genutils==0.2.0
 ipywidgets==7.6.3
 isort==5.9.3
@@ -74,11 +73,11 @@ jupyter-core==4.7.1
 jupyter-server==1.10.2
 jupyter-server-mathjax==0.2.3
 jupyter-sphinx==0.3.2
-jupyterlab==3.1.8
+jupyterlab==3.1.9
 jupyterlab-code-formatter==1.4.10
 jupyterlab-server==2.7.2
 jupyterlab-widgets==1.0.0
-kiwisolver==1.3.1
+kiwisolver==1.3.2
 latexcodec==2.0.1
 lazy-object-proxy==1.6.0
 livereload==2.6.3
@@ -118,7 +117,7 @@ pillow==8.3.1
 pip-tools==6.2.0
 platformdirs==2.2.0
 pluggy==0.13.1
-pre-commit==2.14.0
+pre-commit==2.14.1
 prometheus-client==0.11.0
 prompt-toolkit==3.0.20
 ptyprocess==0.7.0
@@ -147,11 +146,11 @@ pyyaml==5.4.1
 pyzmq==22.2.1
 qrules==0.9.1
 radon==5.1.0
-regex==2021.8.21
+regex==2021.8.28
 requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
-rich==10.7.0
+rich==10.9.0
 send2trash==1.8.0
 six==1.16.0
 smmap==4.0.0
@@ -185,7 +184,7 @@ tqdm==4.62.2
 traitlets==5.0.5
 typed-ast==1.4.3
 types-docutils==0.17.0
-typing-extensions==3.10.0.0 ; python_version < "3.8.0"
+typing-extensions==3.10.0.1 ; python_version < "3.8.0"
 urllib3==1.26.6
 virtualenv==20.7.2
 wcwidth==0.2.5

diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt
@@ -6,20 +6,19 @@
 #
 alabaster==0.7.12
 anyio==3.3.0
-appdirs==1.4.4
 aquirdturtle-collapsible-headings==3.1.0
-argon2-cffi==20.1.0
+argon2-cffi==21.1.0
 astroid==2.7.2
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
 backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
-black==21.7b0
-bleach==4.0.0
+black==21.8b0
+bleach==4.1.0
 certifi==2021.5.30
 cffi==1.14.6
-cfgv==3.3.0
+cfgv==3.3.1
 charset-normalizer==2.0.4
 click==8.0.1
 colorama==0.4.4
@@ -54,12 +53,12 @@ hepunits==2.1.1
 identify==2.2.13
 idna==3.2
 imagesize==1.2.0
-importlib-metadata==4.6.4
+importlib-metadata==4.8.1
 importlib-resources==5.2.2
 iniconfig==1.1.1
 ipykernel==6.2.0
 ipympl==0.7.0
-ipython==7.26.0
+ipython==7.27.0
 ipython-genutils==0.2.0
 ipywidgets==7.6.3
 isort==5.9.3
@@ -73,11 +72,11 @@ jupyter-core==4.7.1
 jupyter-server==1.10.2
 jupyter-server-mathjax==0.2.3
 jupyter-sphinx==0.3.2
-jupyterlab==3.1.8
+jupyterlab==3.1.9
 jupyterlab-code-formatter==1.4.10
 jupyterlab-server==2.7.2
 jupyterlab-widgets==1.0.0
-kiwisolver==1.3.1
+kiwisolver==1.3.2
 latexcodec==2.0.1
 lazy-object-proxy==1.6.0
 livereload==2.6.3
@@ -117,7 +116,7 @@ pillow==8.3.1
 pip-tools==6.2.0
 platformdirs==2.2.0
 pluggy==0.13.1
-pre-commit==2.14.0
+pre-commit==2.14.1
 prometheus-client==0.11.0
 prompt-toolkit==3.0.20
 ptyprocess==0.7.0
@@ -146,11 +145,11 @@ pyyaml==5.4.1
 pyzmq==22.2.1
 qrules==0.9.1
 radon==5.1.0
-regex==2021.8.21
+regex==2021.8.28
 requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
-rich==10.7.0
+rich==10.9.0
 send2trash==1.8.0
 six==1.16.0
 smmap==4.0.0
@@ -183,7 +182,7 @@ tox==3.24.3
 tqdm==4.62.2
 traitlets==5.0.5
 types-docutils==0.17.0
-typing-extensions==3.10.0.0
+typing-extensions==3.10.0.1
 urllib3==1.26.6
 virtualenv==20.7.2
 wcwidth==0.2.5

diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt
@@ -6,20 +6,19 @@
 #
 alabaster==0.7.12
 anyio==3.3.0
-appdirs==1.4.4
 aquirdturtle-collapsible-headings==3.1.0
-argon2-cffi==20.1.0
+argon2-cffi==21.1.0
 astroid==2.7.2
 attrs==20.3.0
 babel==2.9.1
 backcall==0.2.0
 backports.entry-points-selectable==1.1.0
 beautifulsoup4==4.9.3
-black==21.7b0
-bleach==4.0.0
+black==21.8b0
+bleach==4.1.0
 certifi==2021.5.30
 cffi==1.14.6
-cfgv==3.3.0
+cfgv==3.3.1
 charset-normalizer==2.0.4
 click==8.0.1
 colorama==0.4.4
@@ -54,12 +53,12 @@ hepunits==2.1.1
 identify==2.2.13
 idna==3.2
 imagesize==1.2.0
-importlib-metadata==4.6.4
+importlib-metadata==4.8.1
 importlib-resources==5.2.2
 iniconfig==1.1.1
 ipykernel==6.2.0
 ipympl==0.7.0
-ipython==7.26.0
+ipython==7.27.0
 ipython-genutils==0.2.0
 ipywidgets==7.6.3
 isort==5.9.3
@@ -73,11 +72,11 @@ jupyter-core==4.7.1
 jupyter-server==1.10.2
 jupyter-server-mathjax==0.2.3
 jupyter-sphinx==0.3.2
-jupyterlab==3.1.8
+jupyterlab==3.1.9
 jupyterlab-code-formatter==1.4.10
 jupyterlab-server==2.7.2
 jupyterlab-widgets==1.0.0
-kiwisolver==1.3.1
+kiwisolver==1.3.2
 latexcodec==2.0.1
 lazy-object-proxy==1.6.0
 livereload==2.6.3
@@ -117,7 +116,7 @@ pillow==8.3.1
 pip-tools==6.2.0
 platformdirs==2.2.0
 pluggy==0.13.1
-pre-commit==2.14.0
+pre-commit==2.14.1
 prometheus-client==0.11.0
 prompt-toolkit==3.0.20
 ptyprocess==0.7.0
@@ -146,11 +145,11 @@ pyyaml==5.4.1
 pyzmq==22.2.1
 qrules==0.9.1
 radon==5.1.0
-regex==2021.8.21
+regex==2021.8.28
 requests==2.26.0
 requests-unixsocket==0.2.0
 restructuredtext-lint==1.3.2
-rich==10.7.0
+rich==10.9.0
 send2trash==1.8.0
 six==1.16.0
 smmap==4.0.0
@@ -183,7 +182,7 @@ tox==3.24.3
 tqdm==4.62.2
 traitlets==5.0.5
 types-docutils==0.17.0
-typing-extensions==3.10.0.0
+typing-extensions==3.10.0.1
 urllib3==1.26.6
 virtualenv==20.7.2
 wcwidth==0.2.5

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,5 +1,5 @@
 <!-- Fixes #xxx -->
 
-<!-- For the PR title, follow a conventional commit message style: https://pwa.readthedocs.io/develop.html#commit-conventions -->
+<!-- For the PR title, follow a conventional commit message style: https://compwa-org.readthedocs.io/en/stable/develop.html#commit-conventions -->
 
 <!-- Contents of this PR appear in the release notes. Please use screenshots, code snippets etc. to illustrate proposed changes -->