Skip to content

Commit b98ca74

Browse files
committed
Update README.md
1 parent 4e28da9 commit b98ca74

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,29 @@ Evalica has a built-in [Gradio](https://www.gradio.app/) application that can be
114114
[PageRank]: https://doi.org/10.1016/S0169-7552(98)00110-X
115115
[Newman]: https://jmlr.org/papers/v24/22-1086.html
116116

117+
## Contributing
118+
119+
Evalica is a mixed Rust/Python project that uses [PyO3](https://pyo3.rs/), so it requires setting up the [Maturin](https://www.maturin.rs/) build system.
120+
121+
To set up the environment, we recommend using the [uv](https://github.com/astral-sh/uv) package manager, as demonstrated in [our test suite](.github/workflows/test.yml):
122+
123+
```console
124+
$ uv venv
125+
$ uv pip install maturin
126+
$ maturin develop --uv --extras dev,docs,gradio
127+
```
128+
129+
In case `uv` is not available, you can use the following workaround:
130+
131+
```console
132+
$ python3 -m venv venv
133+
$ source venv/bin/activate
134+
$ pip install maturin
135+
$ maturin develop --extras dev,docs,gradio
136+
```
137+
138+
We welcome pull requests on GitHub: <https://github.com/dustalov/evalica>. To contribute, fork the repository, create a separate branch for your changes, and submit a pull request.
139+
117140
## Citation
118141

119142
- Ustalov, D. [Reliable, Reproducible, and Really Fast Leaderboards with Evalica](https://aclanthology.org/2025.coling-demos.6). 2025. Proceedings of the 31st International Conference on Computational Linguistics: System Demonstrations. 46&ndash;53. arXiv: [2412.11314 [cs.CL]](https://arxiv.org/abs/2412.11314).

0 commit comments

Comments
 (0)