Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dirsigler authored Mar 13, 2024
1 parent 72d5d04 commit 646febc
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

## Set up your machine

`incidentio-exporter` is written in [Go](https://golang.org/).

Prerequisites:

- [Go 1.22+](https://go.dev/doc/install)

Clone `incidentio-exporter` anywhere:

```sh
git clone [email protected]:dirsigler/incidentio-exporter.git
```

## Test your change

Add your changes to the code and build the binary as well as Dockerimage locally.
You can use the example Docker Compose stack in [./examples/docker/](./examples/docker/) to see the changes live.

Else verify that a `curl http://localhost:9193/metrics` responds with the desired Prometheus metrics.

## Create a commit

Commit messages should be well formatted.

## Submit a pull request

Push your branch to your `incidentio-exporter` fork and open a pull request against the main branch.

0 comments on commit 646febc

Please sign in to comment.