Merge pull request #1047 from miketheman/miketheman/fix-contrib

misc: update contributing guidelines

CONTRIBUTING.rst

@@ -19,7 +19,13 @@ Feature requests/proposals
 #. Provide as detailed description as possible
     * Use case is great to have
 #. There'll be a bit of discussion for the feature. Don't worry, if it is to be accepted, we'd like to support it, so we need to understand it thoroughly.
-
+
+Development
+-----------
+
+#. Fork the repository
+#. Clone the repository
+#. Create a virtual environment with ``pipenv install --dev``
 
 Pull requests
 -------------
@@ -46,7 +52,11 @@ Coding style
 Testing
 -------
 
-# Tests are written using pytest.
-# PR tests run on Github Actions.
-# In order to run the tests locally you need to have one version of postgres installed. And pass envvar named `POSTGRES` with used version number
-# If you encounter any test failures due to locale issues, make sure that both `en_US.UTF-8` and `de_DE.UTF-8` are enabled in `/etc/locale.gen` and then run `sudo locale-gen`.
+#. Tests are written using `pytest <https://docs.pytest.org/>`_
+#. PR tests run on Github Actions.
+#. Run a PostgreSQL server [#]_, and create a default super user ``createuser --superuser postgres``
+#. Set envvar named ``POSTGRES`` with used version number
+#. Run tests with ``pipenv run pytest``
+#. If you encounter any test failures due to locale issues, make sure that both ``en_US.UTF-8`` and ``de_DE.UTF-8`` are enabled in ``/etc/locale.gen`` and then run ``sudo locale-gen``.
+
+.. [#] Installing and configuring a PostgreSQL server is out of scope of this document. Please refer to `PostgreSQL documentation <https://www.postgresql.org/docs/>`_ for more information.

Pipfile

@@ -11,6 +11,7 @@ psycopg = "==3.2.3"
 
 [dev-packages]
 towncrier = "==24.8.0"
+psycopg-binary = "==3.2.3"
 pytest-cov = "==6.0.0"
 pytest-xdist = "==3.6.1"
 mock = "==5.1.0"

newsfragments/1047.misc.rst

@@ -0,0 +1,2 @@
+Update contributing guidelines.
+Simplify development installation with `psycopg-binary`.