Skip to content

Commit f8a629b

Browse files
authored
Merge pull request #133 from oclyke/oclyke/docs-contribute
docs(README.md): add basic contributing guide
2 parents 39bbea9 + 15ceaa5 commit f8a629b

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
@@ -193,3 +193,23 @@ table = client.query(
193193
print(table.to_pandas())
194194
```
195195
You may also include your own root certificate via this manor aswell.
196+
197+
# Contributing
198+
199+
Tests are run using `pytest`.
200+
201+
```bash
202+
# Clone the repository
203+
git clone https://github.com/InfluxCommunity/influxdb3-python
204+
cd influxdb3-python
205+
206+
# Create a virtual environment and activate it
207+
python3 -m venv .venv
208+
source .venv/bin/activate
209+
210+
# Install the package and its dependencies
211+
pip install -e .[pandas,polars,dataframe,test]
212+
213+
# Run the tests
214+
python -m pytest .
215+
```

0 commit comments

Comments
 (0)