You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,8 @@ When contributing, we expect you to:
37
37
- close an existing issue. If there is none yet for your fix, please [create one](https://github.com/gis-ops/routingpy/issues/new).
38
38
- write/adapt unit tests and/or mock API tests, depending on the introduced or fixed functionality
39
39
- limit the number of commits to a minimum, i.e. responsible use of [`git commit --amend [--no-edit]`](https://www.atlassian.com/git/tutorials/rewriting-history#git-commit--amend)
40
-
- use meaningful commit messages, e.g. `commit -m "[bugfix] heremaps used [lat, long] as locations input parameter"`
40
+
- use meaningful commit messages (and ideally follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
41
+
specification), e.g. `commit -m "fix: heremaps used [lat, long] as locations input parameter"`
41
42
- you can branch off `master` and put a PR against `master` as well
42
43
43
44
### Setup
@@ -77,7 +78,7 @@ pre-commit install
77
78
78
79
We only do mocked tests as routing results heavily depend on underlying data, which, at least in the case of the FOSS routing
79
80
engines, changes on a very regular basis due to OpenStreetMap updates. All queries and most mocked responses are located in
80
-
`test/test_helper.py` in `dict`s. This unfortunately also means, that our tests are less API tests and more unit tests and can't catch
81
+
`test/data/mock.py` in `dict`s. This unfortunately also means, that our tests are less API tests and more unit tests and can't catch
0 commit comments