Skip to content

Commit c1516d6

Browse files
authored
Update contributing guidelines for submodule initialization
1 parent 2039028 commit c1516d6

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ For instructions on installing as a user, see [README.md](README.md)
88
Developers should:
99

1010
1. Clone the repository
11-
2. Create a virtual environment, using e.g. virtualenv or conda. Make sure to use Python3 (e.g. `$ virtualenv venv -p python3`). (If you are on windows you might need to install virtual env first with `pip install virtualenv`. Make sure your python3 installation is in your path.)
12-
3. Activate the environment (e.g. `$ source venv/bin/activate`). (On Windows, virtualenv creates a batch file to activate the virtualenv: `\path\to\env\Scripts\activate`)
13-
4. Install the developer requirements into the virtual environment: `pip install -r dev-requirements/dev.txt`
14-
5. Run the tests: `$ python -m pytest`.
11+
2. Run `git submodule init` and `git submodule update` as some subfolders that are required are from other git repos.
12+
3. Create a virtual environment, using e.g. virtualenv or conda. Make sure to use Python3 (e.g. `$ virtualenv venv -p python3`). (If you are on windows you might need to install virtual env first with `pip install virtualenv`. Make sure your python3 installation is in your path.)
13+
4. Activate the environment (e.g. `$ source venv/bin/activate`). (On Windows, virtualenv creates a batch file to activate the virtualenv: `\path\to\env\Scripts\activate`)
14+
5. Install the developer requirements into the virtual environment: `pip install -r dev-requirements/dev.txt`
15+
6. Run the tests: `$ python -m pytest`.
1516

1617
### Requirements
1718

0 commit comments

Comments
 (0)