Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
tgross committed Nov 6, 2015
1 parent 91cd86b commit cadb5e6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Contributing

Please report any issues you encounter with Containerbuddy or its documentation by opening a Github issue (https://github.com/joyent/containerbuddy/issues). Roadmap items will be maintained as [enhancements](https://github.com/joyent/containerbuddy/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). PRs are welcome on any issue.


Thanks to the following contributors:
- [@bbox-kula](https://github.com/bbox-kula): [first steps to allowing multiple discovery backends](https://github.com/joyent/containerbuddy/pull/4)
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,9 @@ Backend fields:

*Note that if you're using `curl` to check HTTP endpoints for health checks, that it doesn't return a non-zero exit code on 404s or similar failure modes by default. Use the `--fail` flag for curl if you need to catch those cases.*

### Roadmap

As yet unimplemented features of containerbuddy include:
- Accept a `kill -HUP` to force a reload of configuration on external changes.
- Allow polling or TTLs to be tuned live, maybe by querying a key in Consul.
- Allow configuration to include tags about the service to register in Consul (ex. "prod", "dev").
- Allow alternative service discovery backends other than Consul.
- Reaping health checks from Consul some time after an application has been scaled away; currently if an instance is removed intentionally (rather than simply failing health checks) it will not be automatically removed from Consul.
### Contributing

Please report any issues you encounter with Containerbuddy or its documentation by opening a Github issue (https://github.com/joyent/containerbuddy/issues). Roadmap items will be maintained as [enhancements](https://github.com/joyent/containerbuddy/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). PRs are welcome on any issue.

### Running the example

Expand Down

0 comments on commit cadb5e6

Please sign in to comment.