-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributing docs and issu template
- Loading branch information
Showing
3 changed files
with
58 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Attention! --> | ||
<!-- Before submitting an issue, confirm the following: --> | ||
<!-- 1. You have searched previous open/closed issues --> | ||
<!-- 2. Your issue is directly related to django-dramatiq and NOT the dramatiq core library --> | ||
|
||
## Expected Behavior | ||
<!-- If you are requesting a new feature, please elaborate on the problem you are trying to solve --> | ||
|
||
## Actual Behavior | ||
<!-- If you are requesting a new feature, please elaborate on the general solution you are proposing --> | ||
|
||
|
||
## Steps to Reproduce the Problem | ||
<!-- If you are requesting a new feature, please detail the potential implementaion for the feature --> | ||
|
||
1. | ||
1. | ||
1. | ||
|
||
## Specifications | ||
<!-- If you are requesting a new feature, please delete this section --> | ||
|
||
- Django Dramatiq Version: | ||
- Dramatiq Version | ||
- Django Version: | ||
- Broker (Redis, RabbitMQ) + Version: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters