Skip to content

chore: add bugs.url metadata to all published packages#470

Merged
AlemTuzlak merged 1 commit into
mainfrom
docs/add-bugs-url-metadata
Jun 22, 2026
Merged

chore: add bugs.url metadata to all published packages#470
AlemTuzlak merged 1 commit into
mainfrom
docs/add-bugs-url-metadata

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

What

Adds the bugs field to every publishable package under packages/, pointing at the GitHub issue tracker:

"bugs": {
  "url": "https://github.com/TanStack/devtools/issues"
}

Why

While auditing package metadata, bugs was the only standard npm/TanStack metadata field missing across the packages. Everything else (repository with directory, license: MIT, homepage, funding, author, keywords) was already present and consistent. Adding bugs.url gives npm/registry UIs a proper "report issues" link for each package.

Scope

All 13 publishable packages:

  • @tanstack/devtools
  • @tanstack/devtools-client
  • @tanstack/devtools-ui
  • @tanstack/devtools-utils
  • @tanstack/devtools-vite
  • @tanstack/devtools-a11y
  • @tanstack/devtools-event-bus
  • @tanstack/devtools-event-client
  • @tanstack/angular-devtools
  • @tanstack/preact-devtools
  • @tanstack/react-devtools
  • @tanstack/solid-devtools
  • @tanstack/vue-devtools

Private packages (root, examples/*) were intentionally left untouched — they're never published.

Notes

  • No changeset included since this is non-functional package metadata; the new field will ride along with each package's next release. Happy to add changesets if a version bump per package is preferred.

Summary by CodeRabbit

  • Chores
    • Added bug reporting metadata to all packages, providing users with a centralized location to report and track issues on GitHub.

Adds the `bugs` field pointing to the GitHub issue tracker to every publishable package under packages/. This was the only standard metadata field missing; repository, license, homepage, funding, author and keywords were already present and consistent across all packages.
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e032b0f0-5e74-437c-a214-38ffcc6013c5

📥 Commits

Reviewing files that changed from the base of the PR and between fca4065 and 3a8ed23.

📒 Files selected for processing (13)
  • packages/angular-devtools/package.json
  • packages/devtools-a11y/package.json
  • packages/devtools-client/package.json
  • packages/devtools-ui/package.json
  • packages/devtools-utils/package.json
  • packages/devtools-vite/package.json
  • packages/devtools/package.json
  • packages/event-bus-client/package.json
  • packages/event-bus/package.json
  • packages/preact-devtools/package.json
  • packages/react-devtools/package.json
  • packages/solid-devtools/package.json
  • packages/vue-devtools/package.json

📝 Walkthrough

Walkthrough

A bugs field pointing to https://github.com/TanStack/devtools/issues is added to the package.json of all 13 packages in the monorepo. No other metadata, dependencies, scripts, or runtime configuration is changed.

Changes

Package metadata: bugs field

Layer / File(s) Summary
Add bugs.url to all package manifests
packages/angular-devtools/package.json, packages/devtools-a11y/package.json, packages/devtools-client/package.json, packages/devtools-ui/package.json, packages/devtools-utils/package.json, packages/devtools-vite/package.json, packages/devtools/package.json, packages/event-bus-client/package.json, packages/event-bus/package.json, packages/preact-devtools/package.json, packages/react-devtools/package.json, packages/solid-devtools/package.json, packages/vue-devtools/package.json
Each package manifest gains a bugs object with url set to the GitHub issues page. The change is identical across all 13 packages.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hippity hop, a tiny new link,
Thirteen package.json files, quick as a wink!
Now when bugs come a-crawling across the land,
A URL is ready, just perfectly planned.
No more lost issues adrift in the night —
The bunny has filed them, and everything's right! 🐾

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description comprehensively explains the change, motivation, scope, and rationale, though it does not follow the provided template structure with its specific sections and checklist items. Consider restructuring the description to match the template format (## 🎯 Changes, ## ✅ Checklist, ## 🚀 Release Impact) for consistency with repository standards.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: add bugs.url metadata to all published packages' clearly and concisely describes the main change in the PR—adding a bugs field to package metadata across all publishable packages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-bugs-url-metadata

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.

❤️ Share

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

@nx-cloud

nx-cloud Bot commented Jun 22, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 3a8ed23

Command Status Duration Result
nx affected --targets=test:eslint,test:sherif,t... ✅ Succeeded 2m 57s View ↗
nx run-many --targets=build --exclude=examples/** ✅ Succeeded 40s View ↗

☁️ Nx Cloud last updated this comment at 2026-06-22 10:34:22 UTC

@pkg-pr-new

pkg-pr-new Bot commented Jun 22, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-devtools

npm i https://pkg.pr.new/@tanstack/angular-devtools@470

@tanstack/devtools

npm i https://pkg.pr.new/@tanstack/devtools@470

@tanstack/devtools-a11y

npm i https://pkg.pr.new/@tanstack/devtools-a11y@470

@tanstack/devtools-client

npm i https://pkg.pr.new/@tanstack/devtools-client@470

@tanstack/devtools-ui

npm i https://pkg.pr.new/@tanstack/devtools-ui@470

@tanstack/devtools-utils

npm i https://pkg.pr.new/@tanstack/devtools-utils@470

@tanstack/devtools-vite

npm i https://pkg.pr.new/@tanstack/devtools-vite@470

@tanstack/devtools-event-bus

npm i https://pkg.pr.new/@tanstack/devtools-event-bus@470

@tanstack/devtools-event-client

npm i https://pkg.pr.new/@tanstack/devtools-event-client@470

@tanstack/preact-devtools

npm i https://pkg.pr.new/@tanstack/preact-devtools@470

@tanstack/react-devtools

npm i https://pkg.pr.new/@tanstack/react-devtools@470

@tanstack/solid-devtools

npm i https://pkg.pr.new/@tanstack/solid-devtools@470

@tanstack/vue-devtools

npm i https://pkg.pr.new/@tanstack/vue-devtools@470

commit: 3a8ed23

@AlemTuzlak AlemTuzlak merged commit f17d7e8 into main Jun 22, 2026
10 checks passed
@AlemTuzlak AlemTuzlak deleted the docs/add-bugs-url-metadata branch June 22, 2026 14:35
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.

1 participant