Skip to content

Commit 15905f8

Browse files
committed
chore: add CONTRIBUTING.md
1 parent 11de031 commit 15905f8

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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+
## Install `uv`
20+
21+
Follow the [`uv` installation instructions](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer) to install the tool.
22+
23+
## Sync Dependencies
24+
25+
Run the following command to sync all dependencies, including development and extras:
26+
27+
```sh
28+
uv sync --all-extras --dev --locked
29+
```
30+
31+
This command ensures that all necessary dependencies are installed and up-to-date.
32+
33+
## Running Tests
34+
35+
To run the tests, use the following command:
36+
37+
```sh
38+
uv run pytest
39+
```
40+
41+
Thank you for your contributions! If you have any questions, feel free to open an issue or reach out to the maintainers.
42+
43+
44+
## Release
45+
46+
We use [`git-cliff`](https://git-cliff.org/) and [`bumpver`](https://github.com/mbarkhau/bumpver) to manage versioning.
47+
48+
Ensure you have installed `git-cliff`:
49+
50+
```sh
51+
cargo binstall git-cliff
52+
```
53+
54+
To release a new version, for example a patch, run the following command:
55+
56+
57+
```sh
58+
uvx bumpver update --patch --dry
59+
```

0 commit comments

Comments
 (0)