Skip to content

Commit c0fa9a9

Browse files
authored
Merge pull request #76 from jreiberkyle/testing
add contributing section to README outlining testing
2 parents 80370b9 + 14a339f commit c0fa9a9

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,31 @@ model.evaluate(x_test, y_test, batch_size=16)
142142

143143
For more detailed walkthroughs, check out the [examples page](examples)
144144

145+
## Contributing
146+
147+
### Installation
148+
149+
Install in development mode using
150+
```
151+
pip install -e .
152+
```
153+
154+
### Testing
155+
156+
Tests are run using `unittest`. Unit tests are at `tests/unit` and
157+
integration tests are at `tests/integration`.
158+
159+
You can test a single file like:
160+
```
161+
python -m unittest test/unit/test_validate.py
162+
```
163+
or a folder with
164+
```
165+
python -m unittest discover -v -s test/unit
166+
```
167+
Full options [here](https://docs.python.org/3/library/unittest.html)
168+
169+
145170
## Acknowledgements
146171

147172
This library builds on the concepts of [skynet-data](https://github.com/developmentseed/skynet-data). It wouldn't be possible without the excellent data from OpenStreetMap and Mapbox under the following licenses:

0 commit comments

Comments
 (0)