2.0 KiB
Contributing
Thanks for your interest in contributing to Asynq! We are open to, and grateful for, any contributions made by the community.
Reporting Bugs
Have a look at our issue tracker. If you can't find an issue (open or closed) describing your problem (or a very similar one) there, please open a new issue with the following details:
- Which versions of Go and Redis are you using?
- What are you trying to accomplish?
- What is the full error you are seeing?
- How can we reproduce this?
- Please quote as much of your code as needed to reproduce (best link to a public repository or Gist)
Getting Help
We run a Gitter channel where you can ask questions and get help. Feel free to ask there before opening a GitHub issue.
Submitting Feature Requests
If you can't find an issue (open or closed) describing your idea on our issue tracker, open an issue. Adding answers to the following questions in your description is +1:
- What do you want to do, and how do you expect Asynq to support you with that?
- How might this be added to Asynq?
- What are possible alternatives?
- Are there any disadvantages?
Thank you! We'll try to respond as quickly as possible.
Contributing Code
- Fork this repo
- Download your fork
git clone https://github.com/your-username/asynq && cd asynq - Create your branch
git checkout -b your-branch-name - Make and commit your changes
- Push the branch
git push origin your-branch-name - Create a new pull request
Please try to keep your pull request focused in scope and avoid including unrelated commits.
Please run tests against redis cluster locally with --redis_cluster flag to ensure that code works for Redis cluster. TODO: Run tests using Redis cluster on CI.
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
Thank you for contributing!