Skip to content
generated from xmidt-org/.go-template

Consistent hashing with a focus on large numbers of nodes

License

Notifications You must be signed in to change notification settings

xmidt-org/medley

Repository files navigation

medley

medley does something good.

Build Status codecov.io Go Report Card Quality Gate Status Apache V2 License GitHub Release GoDoc

Setup

  1. Search and replace medley with your project name.
  2. Initialize go.mod file: go mod init github.com/xmidt-org/medley
  3. Add org teams to project (Settings > Manage Access):
    • xmidt-org/admins with Admin role
    • xmidt-org/server-writers with Write role
  4. Manually create the first release. After v0.0.1 exists, other releases will be made by automation after the CHANGELOG is updated to reflect a new version header and nothing under the Unreleased header.
  5. For libraries:
    1. Add org workflows in dir .github/workflows: push, tag, and release. This can be done by going to the Actions tab for the repo on the github site.
    2. Remove the following files/dirs: .dockerignore, Dockerfile, Makefile, rpkg.macros, medley.yaml, deploy/, and conf/.

Summary

Medley is a consistent hash package that also exposes a simple API for creating additional hash strategies.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Contributing

Refer to CONTRIBUTING.md.