Skip to content

Commit 2bbb5c7

Browse files
authored
Add instructions for development (#342)
1 parent e191886 commit 2bbb5c7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ discussed with us ahead of time will generally be declined. If you have more gen
2626
feedback or want to discuss using this client with other users, feel free to reach out
2727
on our [Slack channel](https://polygon-io.slack.com/archives/C03FRFN7UF3).
2828

29+
### Development
30+
31+
If you plan to contribute by developing new features then you will need to install certain dependencies.
32+
33+
#### Poetry
34+
35+
Poetry is a packaging and dependency manager for Python.
36+
Installation instructions can be found [on their website](https://python-poetry.org/docs/#installation).
37+
Once installed run `poetry install` to install the required dependencies. This step should be run after incorporating new upstream changes.
38+
39+
#### Makefile
40+
41+
Our Makefile has the common operations needed when developing on this repo. Running tests and linting can both be run through our Makefile. Just run `make help` to see the list of available commands.
42+
2943
## Release planning
3044
This client will attempt to follow the release cadence of our API.
3145
When endpoints are deprecated and newer versions are added, the client will

0 commit comments

Comments
 (0)