Skip to content

Commit d58e714

Browse files
Update readme with development instructions (#2)
1 parent 68b882c commit d58e714

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,26 @@ After installing, a CLI for the chosen connector should be available in the virt
2020
```console
2121
(venv) $ elimity-insights-example-<connector-name>-connector --help
2222
```
23+
24+
## Development
25+
26+
Contributing to these connectors requires [Poetry](https://python-poetry.org/). The examples below show how to perform
27+
some common development tasks, with the working directory set for a specific connector.
28+
29+
### Installing the development environment
30+
31+
```console
32+
$ poetry install
33+
```
34+
35+
### Formatting
36+
37+
```console
38+
$ poetry run black .
39+
```
40+
41+
### Type-checking
42+
43+
```console
44+
$ poetry run mypy .
45+
```

0 commit comments

Comments
 (0)