-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |