Skip to content

Commit 26bdf6a

Browse files
cratelynzhangtianhao
authored andcommitted
chore: add CONTRIBUTING.md instructions (#247)
the test suite in this repository has some implicit dependencies upon `protoc` and the Python client library. in order to help newcomers get situated and effectively contributing to this project, a `CONTRIBUTING.md` file is added to help provide some guidance on how to install the protocol buffer compiler, and how to create and activate a virtual environment with the Python library installed. Signed-off-by: katelyn martin <[email protected]>
1 parent ac3878d commit 26bdf6a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
## Protocol Buffers
4+
5+
The `build.rs` script in this library depends upon the
6+
[Protocol Buffers compiler][protoc]. Be sure that `protoc` is installed and
7+
available within your `PATH`.
8+
9+
[protoc]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc
10+
11+
## Python Dependencies
12+
13+
This repository uses the [`prometheus-client`][client-python] Python client
14+
library in its test suite.
15+
16+
You may create and activate a virtual environment with this dependency
17+
installed by running the following shell commands from the root of this
18+
repository:
19+
20+
```shell
21+
python -m venv ./venv
22+
source venv/bin/activate
23+
pip install prometheus-client
24+
```
25+
26+
[client-python]: https://github.com/prometheus/client_python

0 commit comments

Comments
 (0)