Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 2 KB
Raw

You are interested in contributing to LavinMQ, but you are not sure how to? Right now, you can contribute to LavinMQ in one of two ways:

  1. Code contributions
  2. Non-code contributions

Code contributions

The first step to making a code contribution, is starting a conversation around what you'd like to work on. You can start a conversation around an existing issue or a new one that you've created - refer to reporting an issue. Next:

  1. Fork, create feature branch
  2. Submit pull request

Develop

  1. Run specs with crystal spec
  2. Compile and run locally with crystal run src/lavinmq.cr -- -D /tmp/amqp
  3. Pull js dependencies with make js
  4. Build API docs with make docs (requires npx)
  5. Build with shards build

Release

  1. Update CHANGELOG.md
  2. Bump version in shards.yml
  3. Create and push an annotated tag (git tag -a v$(shards version)), put the changelog of the version in the tagging message

Non-Code contributions

Your schedule won't allow you make code contributions? Still fine, you can:

Report an issue

  • This could be an easily reproducible bug or even a feature request.
  • If you spot an unexpected behaviour but you are not yet sure what the underlying bug is, the best place to post is LavinMQ's community Slack. This would allow us to interactively figure out what is going on.

Give us some feedback

We are also curious and happy to hear about your experience with LavinMQ. You can email us via [email protected] or reach us on Slack. Not sure what to write to us?

  • You can write to us about your first impression of LavinMQ
  • You can talk to us about features that are most important to you or your organization
  • You can also just tell us what we can do better