Skip to content

Repo: improve the issue forms and PR template - #378

Merged
crypt0rr merged 5 commits into
mainfrom
t3code/review-issue-pr-templates
Oct 13, 2026
Merged

crypt0rr merged 5 commits into
mainfrom
t3code/review-issue-pr-templates

Conversation

@jackspiering

@jackspiering jackspiering commented Oct 12, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Improves the issue forms and the PR template, based on a review of the templates against real issues and PRs.

Bug form

  • Asks for the service, ScaleTail version, application image and tag, host platform, and Docker Compose version. The inline configs: content: in the Serve config needs Compose 2.23.1 or newer.
  • Requires steps to reproduce and the output of docker compose ps and docker compose logs. Issues like 🐞 Bug: seafile cannot connect to database #320 and 🐞 Bug: Portainer fails health checks #305 arrived with empty logs.
  • The secrets reminder named TS_KEY, which does not exist. It now names TS_AUTHKEY, and a required checkbox confirms that secrets were removed.
  • Fixes the mismatched quote in the Tailscale version hint and uses tailscale version.

Feature form

New service form

Issue config

  • Links the standard setup.

PR template

  • Drops the # Servicename: context H1, which duplicated the title. The title format stays in the first comment. The rumdl-disable MD041 comment keeps the lint passing without the H1.
  • Drops the "selected the correct label(s)" checkbox. Contributors cannot set labels.
  • Turns Verification into the checks from CONTRIBUTING.md.
  • Adds an "Impact on existing users" section, and items for credentials, README headings, and the root README.

Related Issues

  • None.

Verification

  • rumdl check --config .markdownlint.yml . (rumdl 0.2.78, the CI pin): passes.
  • git diff --check: passes.
  • The four issue forms parse as YAML, and ids are unique per form.
  • Not run: GitHub's rendering of the forms and the required checkboxes. The forms only take effect on the default branch, so they cannot be previewed before merging. Please open the "New issue" chooser after merge.
  • docker compose config does not apply. No service changed.

Impact on existing users

  • None.

Additional Context

  • Not included, because they are maintainer decisions: a SECURITY.md or private vulnerability reporting (the forms ask people to paste .env files), and path-based auto-labeling (actions/labeler needs pull_request_target for fork PRs).
  • Not included: a troubleshooting note on requested tags [] are invalid or not permitted (🐞 Bug: Navidrome tailscale auth failure #342). Its cause was never confirmed in the issue.
  • Group-level required on checkboxes is undocumented, so the new checkbox groups put required: true on each option.

Bug form: ask for the service, ScaleTail version, application image,
host platform, and Compose version; require steps to reproduce and the
output of docker compose ps and logs; add a pre-flight checklist; name
TS_AUTHKEY in the secrets reminder and require a confirmation that
secrets were removed; fix the Tailscale version command.

Feature form: add an area dropdown so existing-service and documentation
requests have a place; turn the contradictory checkboxes into a dropdown.

New service form: require the container image, reword the Compose link
field, add a field for extra requirements, and link the service list.

Issue config: link the standard setup and the Tailscale client tracker.

PR template: drop the duplicate H1 and the label checkbox, replace the
free-text verification with the CONTRIBUTING checks, add an impact
section for existing users, and add credential, README heading, and root
README items.
@jackspiering jackspiering added the enhancement New feature, change or request label Oct 13, 2026
@jackspiering jackspiering self-assigned this Oct 13, 2026
@jackspiering
jackspiering marked this pull request as ready for review October 13, 2026 12:40
@crypt0rr
crypt0rr merged commit 2697ad9 into main Oct 13, 2026
3 checks passed
@crypt0rr
crypt0rr deleted the t3code/review-issue-pr-templates branch October 13, 2026 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature, change or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants