File tree Expand file tree Collapse file tree 1 file changed +63
-0
lines changed Expand file tree Collapse file tree 1 file changed +63
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ Thank you for considering contributing to this project! Here are the steps to set up your development environment:
4+
5+ ## Install System Dependencies
6+
7+ Make sure you have the following system dependencies installed:
8+
9+ - ` clang `
10+ - ` valgrind `
11+
12+ ### Ubuntu
13+
14+ ``` sh
15+ sudo apt-get update
16+ sudo apt-get install clang valgrind -y
17+ ```
18+
19+ ## Init submodules
20+
21+ ``` sh
22+ git submodule update --init
23+ ```
24+
25+ ## Install ` uv `
26+
27+ Follow the [ ` uv ` installation instructions] ( https://docs.astral.sh/uv/getting-started/installation/#standalone-installer ) to install the tool.
28+
29+ ## Sync Dependencies
30+
31+ Run the following command to sync all dependencies, including development and extras:
32+
33+ ``` sh
34+ uv sync --all-extras --dev --locked
35+ ```
36+
37+ This command ensures that all necessary dependencies are installed and up-to-date.
38+
39+ ## Running Tests
40+
41+ To run the tests, use the following command:
42+
43+ ``` sh
44+ uv run pytest
45+ ```
46+
47+ Thank you for your contributions! If you have any questions, feel free to open an issue or reach out to the maintainers.
48+
49+ ## Release
50+
51+ We use [ ` git-cliff ` ] ( https://git-cliff.org/ ) and [ ` bumpver ` ] ( https://github.com/mbarkhau/bumpver ) to manage versioning.
52+
53+ Ensure you have installed ` git-cliff ` :
54+
55+ ``` sh
56+ cargo binstall git-cliff
57+ ```
58+
59+ To release a new version, for example a patch, run the following command:
60+
61+ ``` sh
62+ uvx bumpver update --patch --dry
63+ ```
You can’t perform that action at this time.
0 commit comments