refactor: update addon for current best practises (#21)

* Remove unnecessary file: images/template-button.png

* Remove 'ddev get' from README.md

* README.md should not contain 'project is maintained' badge

* README.md should contain badge: add-on registry

* README.md should contain badge: last commit

* README.md should contain badge: release

* install.yaml should contain 'ddev_version_constraint

* add ISSUE_TEMPLATES for GitHub

* add PULL_REQUEST template for GitHub

* .github/workflows/tests.yml should have 'paths-ignore' for markdown

* docs: refresh and expand README

Author: tyler36

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,45 @@
+name: 🐞 Bug report or Support Request
+description: Create a report to help us improve.
+labels: [bug]
+body:
+  - type: checkboxes
+    attributes:
+      label: Preliminary checklist
+      description: Please complete the following checks before submitting an issue.
+      options:
+        - label: I am using the latest stable version of DDEV
+          required: true
+        - label: I am using the latest stable version of this add-on
+          required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual Behavior
+      description: What actually happened instead?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Specific steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run `...`
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Screenshots? Anything that will give us more context about your issue!
+
+        💡 Attach images or log files by clicking this area to highlight it and dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,35 @@
+name: 🚀 Feature request
+description: Suggest an idea for this project.
+labels: [enhancement]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search existing issues to see if one already exists for your request.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Is your feature request related to a problem?
+      description: Clearly and concisely describe the problem. (Ex. I'm always frustrated when...)
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe your solution
+      description: Clearly and concisely describe what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe alternatives
+      description: Clearly and concisely describe any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request.
+    validations:
+      required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## The Issue
+
+- #<issue number>
+
+<!-- Provide a brief description of the issue. -->
+
+## How This PR Solves The Issue
+
+## Manual Testing Instructions
+
+```bash
+ddev add-on get https://github.com/tyler36/ddev-laravel-queue/tarball/<branch>
+ddev restart
+```
+
+## Automated Testing Overview
+
+<!-- Please describe the tests introduced by this PR, or explain why no tests are needed. -->
+
+## Release/Deployment Notes
+
+<!-- Does this affect anything else or have ramifications for other code? Does anything have to be done on deployment? -->

.github/workflows/tests.yml

@@ -1,8 +1,12 @@
 name: tests
 on:
   pull_request:
+    paths-ignore:
+      - "**.md"
   push:
     branches: [ main ]
+    paths-ignore:
+      - "**.md"
 
   schedule:
   - cron: '01 07 * * *'

README.md

@@ -1,42 +1,52 @@
-# tyler36/ddev-laravel-queue <!-- omit in toc -->
+[![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com)
+[![tests](https://github.com/tyler36/ddev-laravel-queue/actions/workflows/tests.yml/badge.svg)](https://github.com/tyler36/ddev-laravel-queue/actions/workflows/tests.yml)
+[![last commit](https://img.shields.io/github/last-commit/tyler36/ddev-laravel-queue)](https://github.com/tyler36/ddev-laravel-queue/commits)
+[![release](https://img.shields.io/github/v/release/tyler36/ddev-laravel-queue)](https://github.com/tyler36/ddev-laravel-queue/releases/latest)
 
-[![tests](https://github.com/tyler36/ddev-laravel-queue/actions/workflows/tests.yml/badge.svg)](https://github.com/tyler36/ddev-laravel-queue/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2026.svg)
+# DDEV Laravel Queue
 
-- [Introduction](#introduction)
-- [Getting Started](#getting-started)
-- [What does this add-on do and add?](#what-does-this-add-on-do-and-add)
+## Overview
 
-## Introduction
+This add-on runs a Laravel queue worker inside the DDEV web container.
+This add-on is recommended for `QUEUE_CONNECTION=database` environments.
 
-This add-on allows you to start a Laravel queue worker through the DDEV web service. See [offical Queues documentation](https://laravel.com/docs/9.x/queues) for more details.
+See [official Queues documentation](https://laravel.com/docs/master/queues) for more details.
 
-## Getting Started
-
-This add-on requires DDEV v1.19.3 or higher.
-
-- Install the DDEV laravel worker add-on:
-
-For DDEV v1.23.5 or above run
+## Installation
 
 ```shell
 ddev add-on get tyler36/ddev-laravel-queue
+ddev restart
 ```
 
-For earlier versions of DDEV run
+After installation, make sure to commit the `.ddev` directory to version control.
 
-```shell
-ddev get tyler36/ddev-laravel-queue
-```
+## Usage
 
-Then restart the project
+The queue worker automatically runs as a background daemon inside the container. No configuration is required.
+To view queue worker output, check the web container logs.
 
 ```shell
-ddev restart
+$ ddev logs -s web
+...
+2025-09-19 09:12:23,817 INFO spawned: 'queue-1' with pid 1666
+2025-09-19 09:12:27,571 INFO success: queue-1 entered RUNNING state, process has stayed up for > than 3 seconds (startsecs)
+...
+2025-09-19 00:16:13 App\Events\TaskUpdated ....................................................................... RUNNING
+2025-09-19 00:16:13 App\Events\TaskUpdated ....................................................................... 73.82ms DONE
 ```
 
-## What does this add-on do and add?
+## Configuration
+
+`.ddev/config.laravel-workers.yaml` starts the queue work daemon.
+It uses the following configuration settings:
+
+- `--sleep=3` : This option tells the queue worker to sleep for 3 seconds between polling for new jobs when the queue is empty.
+- `--tries=3` : This option specifies that if a job fails, the worker should try to process the job up to three times before sending it to a failed—jobs storage.
+- `sleep 1` : After processing a job, the script pauses for 1 second before re—checking conditions in the loop; this reduces CPU usage by preventing the loop from running too aggressively .
+
+To configure this add-on, remove `#ddev-generated` from `.ddev/config.laravel-workers.yaml` and edit the file as required.
 
-1. Checks to make sure the DDEV version is adequate.
-2. Adds `.ddev/config.laravel-workers.yaml`, which starts the queue worker daemon.
+## Credits
 
 **Contributed and maintained by [tyler36](https://github.com/tyler36)**

images/template-button.png

@@ -1,5 +1,7 @@
 name: ddev-laravel-queue
 
+ddev_version_constraint: '>= v1.24.3'
+
 # list of files and directories listed that are copied into project .ddev directory
 project_files:
 - config.laravel-workers.yaml