Issue reporting

Report A Useful Issue

Good reports make fixes faster. Include the affected script, environment, expected result, actual result, steps to reproduce, and any safe logs or output.

Raise an issueNaming guide

Before Opening An Issue

Search existing issues for duplicatesCheck the docs and repository READMEReproduce using the latest scripts from mainRemove secrets, tokens, passwords, and private URLs

What To Include

Clear summary

Use a short title that names the script and the failure or request.

Environment

Include RMM platform, OS version, shell, script name, script path, and commit if known.

Evidence

Add steps to reproduce, expected result, actual result, command output, and safe logs.

Helpful Commands

Use only the commands that are relevant to the script or system you are reporting.

# Basic Linux system info
uname -a
lsb_release -a || cat /etc/os-release

# Script path and permissions
ls -l "path/to/script.sh"

# Service logs when systemd is involved
sudo journalctl -u servicename --since "1 hour ago" | tail -n 200

General Issue Template

## Issue Description
A clear summary of the issue or question.

## Environment
- RMM platform:
- Operating system and version:
- Script language:
- Script name and path:
- Script commit/version:

## Additional Information
Relevant context, related scripts, links, logs, or screenshots.

## Attachments
Screenshots, redacted logs, or files that help explain the issue.

Bug Report Template

## Bug Description
A clear description of the bug.

## Steps To Reproduce
1. 
2. 
3. 

## Expected Behavior
What should have happened.

## Actual Behavior
What happened instead. Include exact error text when possible.

## Environment
- RMM platform:
- Operating system and version:
- Script language:
- Script name and path:

## Logs Or Screenshots
Paste redacted output in fenced code blocks.

Feature Request Template

## Problem
What limitation or workflow gap are you trying to solve?

## Desired Solution
- Script name(s):
- Desired parameters or switches:
- Expected output or logging:

## Alternatives Considered
Any workaround, manual process, or third-party tool you have tried.

## Environment
- RMM platform:
- Operating system and version:
- Script language:

Priority And Labels

bugA reproducible defect or failure.

enhancementA feature request or workflow improvement.

documentationDocs, examples, naming, or usage guidance.

criticalSecurity exposure, data loss, or serious production impact.

highProduction-breaking behavior with a clear reproduction path.

medium / lowLimited impact, edge cases, polish, or nice-to-have changes.

Pull Requests

Fork the repository, create a feature branch, follow the naming convention, include tests where practical, update docs when behavior changes, and reference the related issue in the PR description.