Skip to content

chore: add issue templates for bug reports and pull + feature requests#1531

Open
colinscz wants to merge 6 commits intonpmx-dev:mainfrom
colinscz:chore/add-issue-templates
Open

chore: add issue templates for bug reports and pull + feature requests#1531
colinscz wants to merge 6 commits intonpmx-dev:mainfrom
colinscz:chore/add-issue-templates

Conversation

@colinscz
Copy link

@colinscz colinscz commented Feb 16, 2026

🔗 Linked issue

Resolves #1522

📚 Description

This PR introduces a minimal template for pull requests, bug reports and feature requests. It also offers a link to the Npmx docs upon clicking the "create issue" button. Credit goes mainly to what is already there on the Nuxt project.

Looks similar to this (minus discussion and security vulnerability options)
image

Added a feature request template to streamline suggestions for feature requests.
@vercel
Copy link

vercel bot commented Feb 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Feb 16, 2026 1:39pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Feb 16, 2026 1:39pm
npmx-lunaria Ignored Ignored Feb 16, 2026 1:39pm

Request Review

Added a section for additional context and tradeoffs.
@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@colinscz colinscz changed the title chore: add issue templates for bug reports and feature requests chore: add issue templates for bug reports and pull + feature requests Feb 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

Adds standardized GitHub templates under .github/ISSUE_TEMPLATE/ and a pull request template. New files: bug-report.yml (bug report form with required description, optional additional context and logs), feature-request.yml (feature request form with labels, required description, optional contribution intent and checklist), config.yml (issue template configuration allowing blank issues and a contact link), and .github/PULL_REQUEST_TEMPLATE.md (lightweight PR template with context, description, testing, and checklist sections).

Suggested reviewers

  • danielroe
🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ❓ Inconclusive The PR introduces additional files (bug-report.yml, feature-request.yml, and config.yml) that extend beyond the PR template requirement in issue #1522. Clarify whether bug report and feature request templates were part of the original scope. If they exceed issue #1522's scope, consider splitting into separate PRs or confirm they align with project standards.
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The PR description clearly relates to the changeset by describing the addition of issue templates and PR templates for the Npmx project.
Linked Issues check ✅ Passed The PR fulfils issue #1522 by adding a PR template with required sections like Context, Description, and a pre-PR checklist, though the exact structure differs slightly from the proposed template.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposal: Add a lightweight Pull Request template

1 participant