Skip to content

Commit c202d59

Browse files
committed
update contributing docs
1 parent 7dfce9c commit c202d59

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/src/piccolo/contributing/index.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@ Get the tests running
1010
---------------------
1111

1212
* Create a new virtualenv
13-
* Clone the `Git repo <https://github.com/piccolo-orm/piccolo>`_.
14-
* Install the dependencies: ``pip install -r requirements.txt``.
15-
* ``cd tests``
16-
* Install the test dependencies: ``pip install -r test-requirements.txt``.
13+
* Clone the `Git repo <https://github.com/piccolo-orm/piccolo>`_
14+
* ``cd piccolo``
15+
* Install default dependencies: ``pip install -r requirements/requirements.txt``
16+
* Install development dependencies: ``pip install -r requirements/dev-requirements.txt``
17+
* Install test dependencies: ``pip install -r requirements/test-requirements.txt``
1718
* Setup Postgres
18-
* Run the tests: ``./run-tests.sh``
19+
* Run the automated code linting/formatting tools: ``./scripts/lint.sh``
20+
* Run the test suite with Postgres: ``./scripts/test-postgres.sh``
21+
* Run the test suite with Sqlite: ``./scripts/test-sqlite.sh``
1922

2023
Contributing to the docs
2124
------------------------

0 commit comments

Comments
 (0)