Skip to content

Commit 0e7ea89

Browse files
committed
chore: minor update in contribution guidelines
- suggest the use of conventional commits - update location of mocked responses for tests
1 parent 07a588e commit 0e7ea89

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ When contributing, we expect you to:
3737
- close an existing issue. If there is none yet for your fix, please [create one](https://github.com/gis-ops/routingpy/issues/new).
3838
- write/adapt unit tests and/or mock API tests, depending on the introduced or fixed functionality
3939
- 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"`
4142
- you can branch off `master` and put a PR against `master` as well
4243

4344
### Setup
@@ -77,7 +78,7 @@ pre-commit install
7778

7879
We only do mocked tests as routing results heavily depend on underlying data, which, at least in the case of the FOSS routing
7980
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
8182
updates on providers' API changes.
8283

8384
```bash

0 commit comments

Comments
 (0)