Update README with contribution details

ECN · Mar 19, 2021 · 38a74e3 · 38a74e3
1 parent 2fe4944
commit 38a74e3
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,3 +19,21 @@ For example, to install version 0.9.1:
 ```
 git+https://github.itap.purdue.edu/ECN/webqueue2-api@0.9.1#egg=webqueue2-api
 ```
+
+## Contributing
+1. Clone the git repo:
+```
+git clone https://github.itap.purdue.edu/ECN/webqueue2-api.git
+```
+2. Create a Python virtual environment:
+```
+python3 -m venv venv
+```
+3. Install dependencies:
+```bash
+# Older versions of pip may fail to install newer packages.
+pip install -U pip
+# Install the webqueue2-api package in editable mode with all extra packages.
+pip install -e .[all]
+```
+4. Make changes and create a PR.