Skip to content

Commit 5bde305

Browse files
committed
Update contributing guide
1 parent 72f7949 commit 5bde305

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ We use [uv](https://docs.astral.sh/uv/) for project management. Install it and s
1111
We use [Poe the Poet](https://poethepoet.natn.io/) as a task runner, similar to npm scripts in `package.json`.
1212
All tasks are defined in `pyproject.toml` under `[tool.poe.tasks]` and can be run with `uv run poe <task>`.
1313

14+
### Available tasks
15+
16+
| Task | Description |
17+
| ---- | ----------- |
18+
| `install-dev` | Install dependencies |
19+
| `check-code` | Run lint, type-check, and unit-tests |
20+
| `lint` | Run linter |
21+
| `format` | Fix lint issues and format code |
22+
| `type-check` | Run type checker |
23+
| `unit-tests` | Run unit tests |
24+
| `unit-tests-cov` | Run unit tests with coverage |
25+
| `build` | Build package |
26+
| `clean` | Remove build artifacts |
27+
1428
## Dependencies
1529

1630
To install this package and its development dependencies, run:
@@ -59,8 +73,6 @@ uv run poe type-check
5973

6074
### Unit tests
6175

62-
We employ pytest as our testing framework, equipped with various plugins. Check pyproject.toml for configuration details and installed plugins.
63-
6476
We use [pytest](https://docs.pytest.org/) as a testing framework with many plugins. Check `pyproject.toml` for configuration details and installed plugins.
6577

6678
To run unit tests:
@@ -77,7 +89,7 @@ uv run poe unit-tests-cov
7789

7890
## Release process
7991

80-
Publishing new versions to [PyPI](https://pypi.org/project/apify) is automated through GitHub Actions.
92+
Publishing new versions to [PyPI](https://pypi.org/project/apify-shared) is automated through GitHub Actions.
8193

8294
- **Beta releases**: On each commit to the master branch, a new beta release is automatically published. The version number is determined based on the latest release and conventional commits. The beta version suffix is incremented by 1 from the last beta release on PyPI.
8395
- **Stable releases**: A stable version release may be created by triggering the `release` GitHub Actions workflow. The version number is determined based on the latest release and conventional commits (`auto` release type), or it may be overridden using the `custom` release type.
@@ -93,18 +105,18 @@ Publishing new versions to [PyPI](https://pypi.org/project/apify) is automated t
93105

94106
```toml
95107
[project]
96-
name = "apify"
108+
name = "apify_shared"
97109
version = "x.z.y"
98110
```
99111

100-
4. Generate the distribution archives for the package:
112+
4. Build the package:
101113

102-
```shell
103-
uv build
114+
```sh
115+
uv run poe build
104116
```
105117

106-
5. Set up the PyPI API token for authentication and upload the package to PyPI:
118+
5. Upload to PyPI:
107119

108-
```shell
120+
```sh
109121
uv publish --token YOUR_API_TOKEN
110122
```

0 commit comments

Comments
 (0)