Skip to content

Commit

Permalink
πŸ“ docs: Add contribution note
Browse files Browse the repository at this point in the history
  • Loading branch information
Bilbottom committed Sep 10, 2023
1 parent 776a8be commit 8e3c952
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,16 @@ To connect to a SQLite database in a read-only way, use the `uri=True` parameter
```python
db_conn = sqlite3.connect("file:path/to/database.db?mode=ro", uri=True)
```

## Contributing 🀝

The Python packaging is managed with [Poetry](https://python-poetry.org/) (check which version in the [poetry.lock](poetry.lock) file), but that should be the only dependency.

To get started, just clone the repo, install the dependencies, and enable [pre-commit](https://pre-commit.com/):

```bash
poetry install --sync --with dev,test
pre-commit install --install-hooks
```

Happy coding! πŸŽ‰

0 comments on commit 8e3c952

Please sign in to comment.