diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..b4f9d29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ + + + + + +## Expected Behavior + + +## Actual Behavior + + + +## Steps to Reproduce the Problem + + + 1. + 1. + 1. + +## Specifications + + + - Django Dramatiq Version: + - Dramatiq Version + - Django Version: + - Broker (Redis, RabbitMQ) + Version: \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4b34f73 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Thank you for contributing to Django Dramatiq! + +We are a [small team of contributors](/CONTRIBUTORS.md) that make this library possible. We are always looking for more help and support. + +Please follow the guidelines provided below to receive the best support possible. + +## Reporting an Issue + +All issues reported to Djang Dramatiq MUST follow the issue template. Any issues that do not follow this template can and will be closed. + +## Running the Project Locally + +1. `git clone` the project +2. Create a virtual environment and install the dev dependencies with `pip install -e '.[dev]'` . +3. Run tests with `python -m pytest` + +Follow the [README.md](/examples/basic/README.md) in the example app for more details. + +## Deploying A New Version + +1. Update [CHANGELOG.md](/CHANGELOG.md) +2. Create a new branch, and bump the version in [`django_dramatiq/__init__.py`](/django_dramatiq/__init__.py) following SEMVER +3. Merge the branch +4. Create a release via the Github UI. Please allow Github to create the changelog +5. Submit the release and tag. +6. Confirm that the github workflow finishes successfully and publishes to pypi. + + diff --git a/README.md b/README.md index 32fe34e..e2030cc 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,12 @@ # django_dramatiq +![Python Version](https://img.shields.io/pypi/pyversions/django-dramatiq) +![Django Versions](https://img.shields.io/pypi/frameworkversions/django/django-dramatiq) [![Build Status](https://github.com/Bogdanp/django_dramatiq/actions/workflows/ci.yml/badge.svg)](https://github.com/Bogdanp/django_dramatiq/actions/workflows/ci.yml) [![PyPI version](https://badge.fury.io/py/django-dramatiq.svg)](https://badge.fury.io/py/django-dramatiq) **django_dramatiq** is a Django app that integrates with [Dramatiq][dramatiq]. - -## Requirements - -* [Python][python] 3.9+ -* [Django][django] 4.2+ -* [Dramatiq][dramatiq] 1.11+ - - ## Example You can find an example application built with django_dramatiq [here][example]. @@ -328,11 +322,6 @@ install(check_options=True) django.setup() ``` -## Running project tests locally - -Install the dev dependencies with `pip install -e '.[dev]'` and then run `python -m pytest`. - - ## License django_dramatiq is licensed under Apache 2.0. Please see