From 1e481e40586ee50d0edb790e8a63455b054c1845 Mon Sep 17 00:00:00 2001 From: Lukas Eller Date: Wed, 14 Apr 2021 09:36:19 +0200 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8ae82d8..cd9dbe0 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,10 @@ to also output stdout use: Alternatively you can directly call individual test modules. For instance: `python -m pytest -s tests/overpy_series_test.py` + +# Coding Guidelines + +* Use [type hints](https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html) for parameters and return values for each function you implement +* Each module should have basic [unit tests](https://realpython.com/python-testing/) so that we can catch coding errors before we push changes +* Common pittfalls --- for instance wrong EPSG --- should be handled via [warnings](https://docs.python.org/3/library/warnings.html) or exceptions so that errors are not introduced silently +* Whenever we are dealing with coordinates, we try to use [geopandas.GeoSeries](https://geopandas.org/reference/geopandas.GeoSeries.html) so that the projection is handled explicitly \ No newline at end of file -- 2.22.0