Skip to content

Commit 15ceaa5

Browse files
committed
docs(README.md): add basic contributing guide
1 parent 70f42dd commit 15ceaa5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,23 @@ table = client.query(
199199
print(table.to_pandas())
200200
```
201201
You may also include your own root certificate via this manor aswell.
202+
203+
# Contributing
204+
205+
Tests are run using `pytest`.
206+
207+
```bash
208+
# Clone the repository
209+
git clone https://github.com/InfluxCommunity/influxdb3-python
210+
cd influxdb3-python
211+
212+
# Create a virtual environment and activate it
213+
python3 -m venv .venv
214+
source .venv/bin/activate
215+
216+
# Install the package and its dependencies
217+
pip install -e .[pandas,polars,dataframe,test]
218+
219+
# Run the tests
220+
python -m pytest .
221+
```

0 commit comments

Comments
 (0)