Skip to main content

Issue Template

Create issue form templates under .github/ISSUE_TEMPLATE/ including config.yml, BUG-REPORT.yml, FEATURE-REQUEST.yml, and SUPPORT-REQUEST.yml.

An interactive multi-select prompt lets you choose which bug report fields to include — fields that match your configured dev platforms are pre-selected.

Why Use This Command?

  • Provides structured issue forms so reporters supply the right details upfront.
  • Generates templates for bug reports, feature requests, and support requests in one step.
  • Injects project-specific pronouns, links, and policies from the Nova config.

Requirements

  • Node.js runtime — Use any Node.js LTS release.
  • Project root — Run the command from the directory containing the top-level package.json.
  • nova.config.json — A valid config file must exist at the project root with the fields listed below.

Usage

Options

FlagDescription
-d, --dry-runPreview the target file path without writing anything to disk.
-r, --replace-fileOverwrite the existing file instead of creating a .nova-backup copy.

Config Fields

FieldDescription
project.pronounsPronoun style (personal or business) for template language.
project.platformsDev platforms used to pre-select matching bug report fields.
urls.githubGitHub repository URL used to build issue links.
urls.fundSourcesFund source URLs used to derive the GitHub sponsor username.
urls.privacyPolicyPrivacy policy URL included in issue template footers.
urls.termsOfUseTerms of use URL included in issue template footers.

Output Files

FileDescription
.github/ISSUE_TEMPLATE/config.ymlIssue template chooser configuration.
.github/ISSUE_TEMPLATE/BUG-REPORT.ymlBug report issue form.
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.ymlFeature request issue form.
.github/ISSUE_TEMPLATE/SUPPORT-REQUEST.ymlSupport request issue form.

How It Works

Interactive Selection

A multi-select prompt lists every available bug report field. Fields that match your configured project.platforms are pre-selected for convenience.

Press space to toggle individual fields, then enter to confirm your selection. If no fields are selected, the generator produces templates without platform-specific fields.

Available Bug Report Fields

FieldTemplate FileCollects
Node.jsnodejs.ymlNode.js version.
Appleapple.ymlDevice type and OS version.
Androidandroid.ymlDevice model and Android version.
C# / .NETcsharp.yml.NET version and operating system.
PHPphp.ymlPHP version.
Pythonpython.ymlPython version.
Homebridgehomebridge.ymlPlugin and Homebridge version.
pfSensepfsense.ymlpfSense version.
Synologysynology.ymlSynology DSM version.
Dockerdocker.ymlDocker version, host OS, architecture, and command.
Web Browserweb.ymlBrowser name and version.
Screenshotsscreenshots.ymlScreenshot upload field.

File Generation

Each output file is built from a built-in template with placeholders replaced by values from the Nova config (pronouns, GitHub repo, legal links, and the selected bug report fields).

If the target file already exists, a .nova-backup copy is created unless --replace-file is set.