Skip to content
This repository has been archived by the owner on Mar 21, 2022. It is now read-only.

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidxia committed Aug 21, 2015
1 parent 9bb588f commit 0b5f1e4
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,41 @@
# Contributing


## Response Times

This project is developed and maintained by an infrastructure team at Spotify. Lots of teams at
Spotify use relatively recent versions of this project in production for mission-critical systems.

That being said, this is our day job where our primary users are our colleagues.
So we might be slow in getting back to you because we're busy working on Spotify-specific things
or because your issues are being prioritized behind those of our colleagues.

Please poke us if you feel you're being neglected, and we'll do our best to get back to you.

## Related Tools You May Find Useful

If you like this project, you might also like [Helios][2], [docker-client][3], [docker-gc][4],
[helios-skydns][5], and [helios-consul][6].

## Reporting Bugs

Please make sure you're using the latest version. This project is
released continuously as it's developed so new releases come out almost as frequently as we
commit to master.

## Contributing

Before creating a new issue, see if there's already an existing issue.

If you create a minor bugfix, feel free to submit a PR.
If your PR is for a significant change or a new feature, feel free to ask for our feedback
before writing code to check we're on the same page.

You can build and test by following [instructions here][1].

[1]: https://github.com/spotify/docker-maven-plugin#testing
[2]: https://github.com/spotify/helios
[3]: https://github.com/spotify/docker-client
[4]: https://github.com/spotify/docker-gc
[5]: https://github.com/spotify/helios-skydns
[6]: https://github.com/spotify/helios-consul
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -172,6 +172,10 @@ Only passwords enclosed in curly braces will be considered as encrypted.
</server>
</servers>

## Testing

Make sure Docker daemon is running and that you can do `docker ps`. Then run `mvn clean test`.

## Releasing

Commits to the master branch will trigger our continuous integration agent to build the jar and
Expand Down

0 comments on commit 0b5f1e4

Please sign in to comment.