Skip to content

docs(issue-template): ask for package manager and version#4867

Merged
escapedcat merged 1 commit into
masterfrom
docs/issue-template-package-manager
Jul 4, 2026
Merged

docs(issue-template): ask for package manager and version#4867
escapedcat merged 1 commit into
masterfrom
docs/issue-template-package-manager

Conversation

@escapedcat

Copy link
Copy Markdown
Member

What

Adds a required Package manager & version field to the bug report issue form.

Why

Module resolution behaves very differently depending on the package manager and install mode — most notably Yarn Plug'n'Play, which has no node_modules. The template already collects commitlint, git, and node versions but never asks which package manager / install mode is in use, so it has to be dragged out of reporters after the fact.

This surfaced in #4864: the real root cause (pure-ESM preset resolution failing under Yarn PnP — same class as #2637 / #3936) only became clear once a reporter mentioned they were on Yarn 4 PnP.

A free-text input (rather than a dropdown) keeps it simple and future-proof as new tools appear; the field description nudges reporters to include the install mode.

🤖 Generated with Claude Code

Package manager and install mode — especially Yarn Plug'n'Play vs a
node_modules linker — frequently determine module-resolution behavior,
but the bug template only collected commitlint/git/node versions. Add a
required free-text field so reporters state their package manager and
version (and, ideally, the install mode).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Add package manager field to bug report issue template

📝 Documentation ⚙️ Configuration changes 🕐 Less than 5 minutes

Grey Divider

AI Description

• Add required “Package manager & version” field to the bug report issue form.
• Prompt reporters to include install mode (e.g., Yarn PnP) to aid resolution debugging.
High-Level Assessment

The following are alternative approaches to this PR:

1. Use a dropdown for known package managers + install modes
  • ➕ More structured data for triage/searching (npm/pnpm/yarn + PnP/node_modules)
  • ➕ Reduces inconsistent free-text responses
  • ➖ Needs maintenance as tools/modes evolve
  • ➖ May not cover edge cases (Bun, custom linkers, future Yarn modes)
2. Split into two fields: package manager/version + install mode
  • ➕ Captures install mode explicitly without relying on reporter phrasing
  • ➕ Easier to filter issues by install mode
  • ➖ More form friction and fields to fill
  • ➖ Install mode taxonomy differs across managers and can confuse reporters

Recommendation: Keep the PR’s free-text single required field. It’s low-friction and future-proof while still nudging for the key signal (install mode), which is often the decisive factor for module-resolution issues (e.g., Yarn PnP vs node_modules).

Files changed (1) +8 / -0

Other (1) +8 / -0
BUG_REPORT.ymlRequire package manager/version (and install mode) in bug reports +8/-0

Require package manager/version (and install mode) in bug reports

• Adds a new required input field asking for the package manager and version, with guidance to include install mode (notably Yarn Plug'n'Play). This complements the existing commitlint/git/node version fields to speed up reproduction and triage.

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@greptile-apps

greptile-apps Bot commented Jul 4, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/BUG_REPORT.yml Adds a required package manager and version field using the same issue-form structure as the existing required version inputs.

Reviews (1): Last reviewed commit: "docs(issue-template): ask for package ma..." | Re-trigger Greptile

@escapedcat escapedcat merged commit 3ab8532 into master Jul 4, 2026
15 checks passed
@escapedcat escapedcat deleted the docs/issue-template-package-manager branch July 4, 2026 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant