Skip to content

Commit

Permalink
Merge pull request #919 from prymitive/docs
Browse files Browse the repository at this point in the history
fix(docs): remove outdated sections from CONTRIBUTING.md
  • Loading branch information
prymitive committed Sep 2, 2019
2 parents ce7f30c + 6810ad0 commit ba8a7da
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ file.
## Git tags and branches

Every release tag name will follow `vX.Y.Z` naming scheme, example: `v0.1.0`.
Every release tree has a dedicated branch named `release-X.Y`, example:
`release-0.1`.
All releases are tagged against the `master` branch.

## Commit messages

Expand All @@ -18,7 +17,7 @@ for all commits.

## Testing changes

To run included tests and check code style with `golint` run:
To run included tests and linters run:

make test

Expand Down Expand Up @@ -59,15 +58,3 @@ When running docker image via `make run-docker` with `DEBUG` make variable set
to `true` volume mapping will be added (in read-only mode), so that karma
instance running inside the docker can read asset files from the sources
directory.

## Adding support for new Alertmanager release

To support a new release that breaks API following changes needs to be done:

- Verify that `GetVersion()` function can still correctly read remote
Alertmanager version via `/api/v1/status` endpoint, adapt it if needed.
- Create a new mapper package implementing unmarshaling of alerts and/or
silences (depending if both need a new code) under mapper/vXY (X major
Alertmanager version, Y minor version).
- Register new mapper in the `init()` function in the
`internal/alertmanager/mapper.go` file.

0 comments on commit ba8a7da

Please sign in to comment.