Update CONTRIBUTING (#197)

Update Contributing docs Signed-off-by: Tawanda Moyo <moyotawanda@gmail.com>
matrix-org · Jun 11, 2021 · 85b2f17 · 85b2f17
1 parent 4f4d7ce
commit 85b2f17
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,6 @@ _trial_temp*
 /.tox
 /.python-version
 /htmlcov
+
+.vscode/
+.idea/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,6 +6,14 @@ this case, the [Apache Software License v2](LICENSE).
 
 ## Preparing your development environment
 
+Sygnal depends on the `psycopg2` database adapter for PostgreSQL. 
+You may need to install development headers for Python and libpq.
+For example on Debian/Ubuntu distributions these can be installed with:
+
+```bash
+sudo apt install libpq-dev python3-dev build-essential
+```
+
 ### Create a virtualenv
 
 To contribute to Sygnal, ensure you have Python 3.7 or newer and then run:

diff --git a/changelog.d/196.doc b/changelog.d/196.doc
@@ -0,0 +1 @@
+Update CONTRIBUTING.md to recommend installing libq-dev. Contributed by Tawanda Moyo.