go-pkg/asynq
2
0
Fork 0
mirror of https://github.com/hibiken/asynq.git synced 2024-12-26 15:52:18 +08:00
Code Issues Projects Releases Wiki Activity

docs: update issue templates, add releatively stable update

Browse Source 
* Ths project should be considered relatively stable because we haven't broken the API in over 2 years.
This commit is contained in:
Mohammed Sohail 2024-10-30 08:41:46 +03:00
parent 917d6f7a7d
commit 3530465e1a
No known key found for this signature in database
GPG Key ID: 7DD45520C01CD85D
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -3,13 +3,20 @@ name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: "[BUG] Description of the bug" title: "[BUG] Description of the bug"
labels: bug labels: bug
assignees: hibiken assignees:
- hibiken
- kamikazechaser
--- ---
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**Environment (please complete the following information):**
- OS: [e.g. MacOS, Linux]
- `asynq` package version [e.g. v0.25.0]
- Redis/Valkey version
**To Reproduce** **To Reproduce**
Steps to reproduce the behavior (Code snippets if applicable): Steps to reproduce the behavior (Code snippets if applicable):
1. Setup background processing ... 1. Setup background processing ...
@ -22,9 +29,5 @@ A clear and concise description of what you expected to happen.
**Screenshots** **Screenshots**
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):**
- OS: [e.g. MacOS, Linux]
- Version of `asynq` package [e.g. v1.0.0]
**Additional context** **Additional context**
Add any other context about the problem here. Add any other context about the problem here.

4
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -3,7 +3,9 @@ name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: "[FEATURE REQUEST] Description of the feature request" title: "[FEATURE REQUEST] Description of the feature request"
labels: enhancement labels: enhancement
assignees: hibiken assignees:
- hibiken
- kamikazechaser
--- ---

5
README.md
View File

@ -45,7 +45,7 @@ Task queues are used as a mechanism to distribute work across multiple machines.
## Stability and Compatibility ## Stability and Compatibility
**Status**: The library is currently undergoing **heavy development** with frequent, breaking API changes. **Status**: The library relatively stable and is currently undergoing **moderate development** with less frequent breaking API changes.
> ☝️ **Important Note**: Current major version is zero (`v0.x.x`) to accommodate rapid development and fast iteration while getting early feedback from users (_feedback on APIs are appreciated!_). The public API could change without a major version update before `v1.0.0` release. > ☝️ **Important Note**: Current major version is zero (`v0.x.x`) to accommodate rapid development and fast iteration while getting early feedback from users (_feedback on APIs are appreciated!_). The public API could change without a major version update before `v1.0.0` release.
@ -53,8 +53,7 @@ Task queues are used as a mechanism to distribute work across multiple machines.
If you are using this package in production, **please consider sponsoring the project to show your support!** If you are using this package in production, **please consider sponsoring the project to show your support!**
## Quickstart ## Quickstart
Make sure you have Go installed ([download](https://golang.org/dl/)). The **last two** Go versions are supported (See https://go.dev/dl).
Make sure you have Go installed ([download](https://golang.org/dl/)). Latest two Go versions are supported (See https://go.dev/dl).
Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://blog.golang.org/using-go-modules)) inside the folder. Then install Asynq library with the [`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command: Initialize your project by creating a folder and then running `go mod init github.com/your/repo` ([learn more](https://blog.golang.org/using-go-modules)) inside the folder. Then install Asynq library with the [`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command: