Skip to content

Commit

Permalink
chore: add CONTRIBUTING.md instructions (#247)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
cratelyn authored Nov 28, 2024
1 parent 12923ca commit 3e6b9e2
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

## Protocol Buffers

The `build.rs` script in this library depends upon the
[Protocol Buffers compiler][protoc]. Be sure that `protoc` is installed and
available within your `PATH`.

[protoc]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc

## Python Dependencies

This repository uses the [`prometheus-client`][client-python] Python client
library in its test suite.

You may create and activate a virtual environment with this dependency
installed by running the following shell commands from the root of this
repository:

```shell
python -m venv ./venv
source venv/bin/activate
pip install prometheus-client
```

[client-python]: https://github.com/prometheus/client_python

0 comments on commit 3e6b9e2

Please sign in to comment.