Skip to content

Create and organize issue templates (GitHub forms, chooser config, security routing) #857

Open

Description

@chappie-daemon

Summary

Modernize the repository's issue templates. Two plain-markdown templates exist (bug_report.md, feature_request.md, both dated) and there is no config.yml, so GitHub shows raw markdown links instead of the template chooser, and blank issues are allowed. This ticket brings the set up to the current GitHub forms standard.

Current state

  • .github/ISSUE_TEMPLATE/bug_report.md — legacy markdown template, labels bug, generic sections
  • .github/ISSUE_TEMPLATE/feature_request.md — legacy markdown template, labels enhancement, carries the pledge paragraph
  • No config.yml (no template chooser, blank issues permitted)
  • No security-reporting template; the repo has a security label and takes vulnerability reports

Proposed set

File Form Labels Notes
config.yml chooser config — blank_issues_enabled: false, contact links section
bug_report.yml GitHub form bug structured fields (see below)
feature_request.yml GitHub form enhancement keep the pledge paragraph, add a pledge-amount field
documentation.yml GitHub form documentation for docs/README gaps (the repo's docs surface is growing: CONFIGURATION.md, CLI.md, website)
security_report.md markdown (private) security points to private vulnerability reporting (GitHub Security Advisories / SECURITY.md); GitHub forms cannot be used for sensitive reports, so this stays markdown

Bug report form fields (draft)

  • What happened (textarea, required) — replaces "describe the bug"
  • Relay version (input, required) — from the startup banner (vX.Y.Z)
  • Deployment (dropdown, required) — docker compose / standalone / railway / other
  • OS (dropdown, required) — Linux / macOS / Windows / other
  • NIPs involved (input, optional) — e.g. NIP-42, NIP-77
  • Logs (textarea, required, code-friendly) — paste of the relevant log section
  • Reproduction steps (textarea, required)
  • Additional context (textarea, optional)

Feature request form fields (draft)

  • Problem (textarea, required) — what are you trying to do
  • Proposed solution (textarea, required)
  • Alternatives considered (textarea, optional)
  • Pledge amount (input, optional, numeric) — feeds the existing pledge policy; keep the pledge paragraph verbatim above the fields
  • Additional context (textarea, optional)

Contact links (config.yml)

Acceptance

  • Template chooser renders when opening a new issue; blank issues disabled
  • Bug report collects version/deployment/OS/logs as structured fields
  • Feature request keeps the pledge policy and adds the pledge field
  • Security reports are directed to private reporting, not a public form
  • Every template auto-assigns the correct existing label (no new labels required)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions