Skip to content

Commit f31df28

Browse files
authored
Document how to contribute
1 parent f9ab8e8 commit f31df28

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ coroutines. The [SDK guide](https://proofline.sh/docs/sdks/) and
2525
Licensed under the Apache License, Version 2.0. The generated models under
2626
`proofline/_generated` carry the MIT license of the generator templates.
2727

28+
## Contributing
29+
30+
This repository distributes the Proofline Python SDK. The public OpenAPI contract generates the client and models in `proofline/_generated/`. Open an issue for changes to the contract or generated code. Pull requests are welcome for the hand-written client in `proofline/client.py`, transport and helpers outside `_generated/`, and tests in `tests/`.
31+
2832
## Exports
2933

3034
`export_reviews` reads one CSV or NDJSON page through the existing bounded transport.

0 commit comments

Comments
 (0)