Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 862 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 862 Bytes
Raw

Contributing

Development

Run tests in Docker:

docker build  . -f spec/Dockerfile -t amqproxy_spec
docker run --rm -it -v $(pwd):/app -w /app --entrypoint bash amqproxy_spec

# ensure rabbitmq is up, run all specs
./entrypoint.sh

# run single spec
crystal spec --example "keeps connections open"

Run tests using Docker Compose:

./run-specs-in-docker.sh

Release

  1. Make a commit that
    1. updates CHANGELOG.md
    2. bumps version in shard.yml
  2. Create and push an annotated tag: git tag -a v$(shards version)
    1. Put the changelog of the version in the tagging message
    2. NOTE: Only the body will be shown in release notes. (The first line in the message is the subject followed by an empty line, then the body on the next line.)