From 3530465e1a3460f2fbd8f1194a749d226a2a3efd Mon Sep 17 00:00:00 2001 From: Mohammed Sohail Date: Wed, 30 Oct 2024 08:41:46 +0300 Subject: [PATCH] docs: update issue templates, add releatively stable update * Ths project should be considered relatively stable because we haven't broken the API in over 2 years. --- .github/ISSUE_TEMPLATE/bug_report.md | 15 +++++++++------ .github/ISSUE_TEMPLATE/feature_request.md | 4 +++- README.md | 5 ++--- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e7faf63..2bbb379 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,13 +3,20 @@ name: Bug report about: Create a report to help us improve title: "[BUG] Description of the bug" labels: bug -assignees: hibiken - +assignees: + - hibiken + - kamikazechaser + --- **Describe the bug** 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** Steps to reproduce the behavior (Code snippets if applicable): 1. Setup background processing ... @@ -22,9 +29,5 @@ A clear and concise description of what you expected to happen. **Screenshots** 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** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index fa64a47..6344132 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -3,7 +3,9 @@ name: Feature request about: Suggest an idea for this project title: "[FEATURE REQUEST] Description of the feature request" labels: enhancement -assignees: hibiken +assignees: + - hibiken + - kamikazechaser --- diff --git a/README.md b/README.md index 40f89f0..6392d33 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Task queues are used as a mechanism to distribute work across multiple machines. ## 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. @@ -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!** ## Quickstart - -Make sure you have Go installed ([download](https://golang.org/dl/)). Latest two Go versions are supported (See https://go.dev/dl). +Make sure you have Go installed ([download](https://golang.org/dl/)). The **last 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: