Skip to content

Commit 42ca24a

Browse files
authored
Replace BUILD.md with CONTRIBUTING.md (#18)
1 parent 143cd6b commit 42ca24a

2 files changed

Lines changed: 30 additions & 74 deletions

File tree

BUILD.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
Requires Python 3.10 or later.
6+
7+
```sh
8+
pip install -e . --group dev
9+
```
10+
11+
## Running Tests
12+
13+
```sh
14+
pytest
15+
16+
# With coverage:
17+
pytest --cov=instaparser
18+
```
19+
20+
## Linting & Type Checking
21+
22+
```sh
23+
ruff check instaparser/ tests/
24+
ruff format --check instaparser/ tests/
25+
mypy
26+
```
27+
28+
## Versioning
29+
30+
The package version is defined in `instaparser/__init__.py` and read by setuptools at build time via `[tool.setuptools.dynamic]` in `pyproject.toml`.

0 commit comments

Comments
 (0)