CONTRIBUTING.md 1006 Bytes
Newer Older
1 2 3 4
# Contributing

Prometheus uses GitHub to manage reviews of pull requests.

5 6 7
* If you have a trivial fix or improvement, go ahead and create a pull request,
  addressing (with `@...`) the maintainer of this repository (see
  [MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
8 9 10 11 12 13 14 15 16 17 18

* If you plan to do something more involved, first discuss your ideas
  on our [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
  This will avoid unnecessary work and surely give you and us a good deal
  of inspiration.

* Relevant coding style guidelines are the [Go Code Review
  Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
  and the _Formatting and style_ section of Peter Bourgon's [Go: Best
  Practices for Production
  Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).
19 20 21 22 23 24 25 26 27 28 29


## Local setup

The easiest way to make a local development setup is to use Docker Compose.

```
docker-compose up
make
make test
```