You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
chore: modernize the issue templates as GitHub forms - #1146
Replaces the two legacy markdown issue templates with the set proposed in #857.
config.yml: turns blank issues off so every issue starts from a template, and adds contact links for private vulnerability reporting (GitHub Security Advisories), the development chat, the Nostr protocol chat and the website, the three links the issue lists.
bug_report.yml: a form with the fields a maintainer needs to reproduce a bug (what happened, relay version, deployment, OS, NIPs involved, logs, reproduction steps, extra context).
feature_request.yml: a form (problem, proposed solution, alternatives, pledge amount, extra context) that keeps the pledge paragraph of the old template word for word.
documentation.yml: a form for gaps in the docs, README or website.
security_report.md: a markdown template, since a form cannot be private, that tells the reporter not to describe a vulnerability in a public issue and to use private vulnerability reporting.
Removed bug_report.md and feature_request.md.
The forms set no title prefix and no default assignee. The old templates assigned Cameri to every issue and started the title with [BUG] / [REQUEST], which had to be deleted by hand each time.
A unit test (test/unit/ci/issue-templates.spec.ts) checks the set: blank issues are off, the security link points to private reporting, every form has a name, a description, labels the repository has, unique field ids, valid element types and a required field, the pledge paragraph is intact, and the legacy templates are gone.
Without a config.yml GitHub shows raw markdown links instead of the template chooser and allows blank issues, and the legacy templates were generic. Structured fields mean a report arrives with the version, deployment and logs a maintainer would otherwise have to ask for.
How Has This Been Tested?
New unit test for the templates (35 tests); dropping blank_issues_enabled, adding a label the repository does not have, duplicating a field id, editing the pledge paragraph and assigning someone to a form each make it fail.
Every form file parses as YAML.
pnpm lint, pnpm check:deps, pnpm run build:check, pnpm run test:unit.
Rendering of the forms and the chooser can only be seen on GitHub, once this is merged.
Screenshots (if appropriate):
Types of changes
Non-functional change (docs, style, minor refactor)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my code changes.
I added a changeset, or this is docs-only and I added an empty changeset.
All new and existing tests passed.
Summary by CodeRabbit
New Features
Added guided forms for bug reports, feature requests, and documentation feedback, with fields tailored to each submission.
Added security-report guidance directing vulnerability disclosures to private reporting.
Added links to project resources and discussion channels in the issue submission flow.
No actionable comments were generated in the recent review.
Walkthrough
The repository adds GitHub issue forms for bug reports, feature requests, and documentation reports. The chooser configuration disables blank issues and adds contact links. A security-report template directs vulnerability reports to private reporting. Tests check the configuration, forms, legacy template removal, and CI coverage for template changes.
Changes: Issue Template Modernization
Layer / File(s)
Summary
Issue chooser and security reporting .github/ISSUE_TEMPLATE/config.yml, .github/ISSUE_TEMPLATE/security_report.md
The configuration disables blank issues and adds contact links. The security-report template gives private-reporting instructions and links to SECURITY.md.
Issue forms and legacy template removal .github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/documentation.yml, .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, .changeset/issue-templates-forms.md
The YAML forms collect bug, feature request, and documentation details. The legacy bug and feature request Markdown templates are removed. The changeset file gains empty YAML front matter.
Template tests and CI coverage test/unit/ci/issue-templates.spec.ts, .github/workflows/checks.yml
Tests check chooser configuration, form metadata and fields, security-report content, legacy template removal, and the issue-template CI path filter.
This change replaces the old issue templates with structured issue forms, disables blank issues, and adds contact links. It does not touch runtime code. It is low risk to merge. The only open item is checking how the forms render on GitHub after merge.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "chore: modernize the issue templates as GitHub forms" matches the main change. The PR replaces the legacy Markdown bug and feature-request templates with GitHub issue forms (.yml), adds a d…
Linked Issues check
Issue #857 is the only direct linked issue. Its coding requirements cover the issue template files and their checks. The reviewed head implements them:
- Blank issues disabled and contact links: `.gi…
Out of Scope Changes check
All changed files map to the objectives of #857 or support them:
- .github/ISSUE_TEMPLATE/ config, the three forms, the security markdown template, and removal of the two legacy templates. - `test/…
Full details: Title check
Explanation
The title "chore: modernize the issue templates as GitHub forms" matches the main change. The PR replaces the legacy Markdown bug and feature-request templates with GitHub issue forms (.yml), adds a documentation form, a security Markdown template, and chooser config. The title is specific and concise, and a teammate scanning history would understand the primary change. It does not cover the CI path filter or the new spec file, which is acceptable.
Full details: Linked Issues check
Explanation
Issue #857 is the only direct linked issue. Its coding requirements cover the issue template files and their checks. The reviewed head implements them:
Blank issues disabled and contact links: .github/ISSUE_TEMPLATE/config.yml sets blank_issues_enabled: false. It adds the private advisory link, https://t.me/nostream_dev, https://t.me/nostr_protocol, and https://ema.tnsor.network.
Bug report fields: bug_report.yml requires version, deployment, OS, logs, and reproduction steps. It uses the bug label.
Feature request: feature_request.yml keeps the pledge paragraph and adds an optional pledge input. It uses the enhancement label.
Documentation form: documentation.yml exists and uses the documentation label.
Security routing: security_report.md directs reporters to private vulnerability reporting and uses the security label.
No default assignee and no title prefix in the forms. The legacy bug_report.md and feature_request.md are removed.
Automated checks: test/unit/ci/issue-templates.spec.ts covers these requirements.
Changes since the previous reviewed head (3e350d1) add a .github/ISSUE_TEMPLATE/** path to the src filter in .github/workflows/checks.yml. This supports the template test scope. It does not change the issue requirements.
Unresolved uncertainty: the test uses a hardcoded REPOSITORY_LABELS list. It does not read labels from GitHub. Existence of the documentation and security labels on GitHub is not verified here. Template rendering is non-coding and can only be checked after merge.
Full details: Out of Scope Changes check
Explanation
All changed files map to the objectives of #857 or support them:
.github/ISSUE_TEMPLATE/ config, the three forms, the security markdown template, and removal of the two legacy templates.
test/unit/ci/issue-templates.spec.ts, which verifies the template set.
.github/workflows/checks.yml, which adds .github/ISSUE_TEMPLATE/** to the src path filter. This gates checks for template-only changes and supports the template test. It is not a separate feature.
.changeset/issue-templates-forms.md, the release-process file for this change.
The whole-PR summary shows no unrelated code changes.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit checks each form with care, A bug report has fields to share. A pledge may find its proper place, Private reports keep safer space. The chooser points the way ahead.
Recent review info
Automatic approval policy
Commit: 4302c06b5089.
Setting
Effective value
Source
Automatic approvals
Enabled
Global configuration
Merge risk
Minimal
Global configuration
Security risk
Not set
Global configuration
Not set means no limit was configured after inheritance. Use @coderabbitai configuration to inspect the resolved settings and their sources.
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: 4a59b636-6dc6-4248-9109-211671e2df17
Commits
Reviewing files that changed from the base of the PR and between 3e350d1 and 4302c06.
Files selected for processing: 2
.github/workflows/checks.yml
test/unit/ci/issue-templates.spec.ts
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Replaces the two legacy markdown issue templates with the set proposed in #857.
config.yml: turns blank issues off so every issue starts from a template, and adds contact links for private vulnerability reporting (GitHub Security Advisories), the development chat, the Nostr protocol chat and the website, the three links the issue lists.bug_report.yml: a form with the fields a maintainer needs to reproduce a bug (what happened, relay version, deployment, OS, NIPs involved, logs, reproduction steps, extra context).feature_request.yml: a form (problem, proposed solution, alternatives, pledge amount, extra context) that keeps the pledge paragraph of the old template word for word.documentation.yml: a form for gaps in the docs, README or website.security_report.md: a markdown template, since a form cannot be private, that tells the reporter not to describe a vulnerability in a public issue and to use private vulnerability reporting.bug_report.mdandfeature_request.md.The forms set no title prefix and no default assignee. The old templates assigned
Camerito every issue and started the title with[BUG]/[REQUEST], which had to be deleted by hand each time.A unit test (
test/unit/ci/issue-templates.spec.ts) checks the set: blank issues are off, the security link points to private reporting, every form has a name, a description, labels the repository has, unique field ids, valid element types and a required field, the pledge paragraph is intact, and the legacy templates are gone.Related Issue
Closes #857
Motivation and Context
Without a
config.ymlGitHub shows raw markdown links instead of the template chooser and allows blank issues, and the legacy templates were generic. Structured fields mean a report arrives with the version, deployment and logs a maintainer would otherwise have to ask for.How Has This Been Tested?
blank_issues_enabled, adding a label the repository does not have, duplicating a field id, editing the pledge paragraph and assigning someone to a form each make it fail.pnpm lint,pnpm check:deps,pnpm run build:check,pnpm run test:unit.Screenshots (if appropriate):
Types of changes
Checklist:
Summary by CodeRabbit