mirror of
https://github.com/pocketpy/pocketpy
synced 2026-08-05 05:37:10 +08:00
66ff339bb9
* Initial plan * docs: add contributing guide and link from README --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
72 lines
1.3 KiB
Markdown
72 lines
1.3 KiB
Markdown
# Contributing to pocketpy
|
|
|
|
Thank you for your interest in contributing to pocketpy.
|
|
|
|
## Development Environment
|
|
|
|
### Prerequisites
|
|
|
|
- Python 3
|
|
- CMake 3.10+
|
|
- A C11 compiler
|
|
- Linux/macOS: `clang` or `gcc`
|
|
- Windows: MSVC (recommended)
|
|
|
|
### Clone the repository
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/pocketpy/pocketpy.git
|
|
cd pocketpy
|
|
```
|
|
|
|
## Build from Source
|
|
|
|
A standard local build:
|
|
|
|
```bash
|
|
python cmake_build.py Release
|
|
```
|
|
|
|
A build with optional modules (same style as CI):
|
|
|
|
```bash
|
|
python cmake_build.py Release -DPK_BUILD_MODULE_LZ4=ON -DPK_BUILD_MODULE_CUTE_PNG=ON -DPK_BUILD_MODULE_MSGPACK=ON
|
|
```
|
|
|
|
Build outputs are copied to the repository root (`main`, and `libpocketpy.so`/`pocketpy.dll`/`libpocketpy.dylib` when available).
|
|
|
|
## Run Tests
|
|
|
|
Run unit tests:
|
|
|
|
```bash
|
|
python scripts/run_tests.py
|
|
```
|
|
|
|
Run benchmarks:
|
|
|
|
```bash
|
|
python scripts/run_tests.py benchmark
|
|
```
|
|
|
|
On Linux, you can run the existing coverage script:
|
|
|
|
```bash
|
|
bash run_tests.sh
|
|
```
|
|
|
|
## Notes for Contributors
|
|
|
|
- `python cmake_build.py` and `bash run_tests.sh` run `python prebuild.py` automatically.
|
|
- If you edit files under `python/`, regenerate embedded sources with:
|
|
|
|
```bash
|
|
python prebuild.py
|
|
```
|
|
|
|
## Pull Requests
|
|
|
|
- Keep changes focused and minimal.
|
|
- Add/update tests when code behavior changes.
|
|
- Open a PR with a clear summary of what changed and why.
|