hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 23:42:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1847 from willingc/update-contributing

Browse Source 
Update the contributing instructions for running tests.
This commit is contained in:
Min RK
2018-05-03 14:56:01 +02:00
committed by GitHub
parent 1750ff0324 8498691763
commit 6a47123ec9
1 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md
View File

@@ -2,6 +2,7 @@
Welcome! As a [Jupyter](https://jupyter.org) project, we follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html). Welcome! As a [Jupyter](https://jupyter.org) project, we follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html).
## Set up your development system ## Set up your development system
For a development install, clone the [repository](https://github.com/jupyterhub/jupyterhub) For a development install, clone the [repository](https://github.com/jupyterhub/jupyterhub)
@@ -34,17 +35,28 @@ python3 setup.py css # recompile CSS from LESS sources
## Running the test suite ## Running the test suite
We use [pytest](http://doc.pytest.org/en/latest/) for running tests. Set up a We use [pytest](http://doc.pytest.org/en/latest/) for running tests.
development install as described above. To run all the tests:
1. Set up a development install as described above.
2. Set environment variable for `ASYNC_TEST_TIMEOUT` to 15 seconds:
```bash ```bash
pytest jupyterhub/tests export ASYNC_TEST_TIMEOUT=15
```
3. Run tests.
To run all the tests:
```bash
pytest -v jupyterhub/tests
``` ```
To run an individual test file (i.e. `test_api.py`): To run an individual test file (i.e. `test_api.py`):
```bash ```bash
pytest jupyterhub/tests/test_api.py pytest -v jupyterhub/tests/test_api.py
``` ```
### Troubleshooting tests ### Troubleshooting tests
@@ -63,16 +75,24 @@ If you see many test errors and failures, double check that you have installed
## Building the Docs locally ## Building the Docs locally
Install the dependencies: 1. Install the development system as described above.
2. Install the dependencies for documentation:
```bash ```bash
python3 -m pip install -r docs/requirements.txt python3 -m pip install -r docs/requirements.txt
``` ```
Build the docs: 3. Build the docs:
```bash ```bash
cd docs cd docs
make clean make clean
make html make html
``` ```
4. View the docs:
```bash
open build/html/index.html
```