Skip to content

chore: 💜 add CONTRIBUTING.md instructions #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mxinden merged 1 commit into from
Nov 28, 2024
Merged

chore: 💜 add CONTRIBUTING.md instructions #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
Loading