Skip to content

docs: make the contributing guide link work in package READMEs - #6659

Open
abd1rahmane wants to merge 1 commit into
TanStack:mainfrom
abd1rahmane:docs/package-readme-contributing-links
Open

abd1rahmane wants to merge 1 commit into
TanStack:mainfrom
abd1rahmane:docs/package-readme-contributing-links

Conversation

@abd1rahmane

@abd1rahmane abd1rahmane commented Nov 12, 2026 •

Copy link
Copy Markdown

Changes

The root README is copied into 17 package READMEs by pnpm copy:readme. Its one relative link, ./CONTRIBUTING.md, resolves to packages/<name>/CONTRIBUTING.md in those copies and returns 404. Change it to the absolute GitHub URL in the root README and in the 17 copies, so the link works in both places and survives the next copy:readme.

Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm test and pnpm test:e2e, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated contribution guide links across project and package documentation to point to the repository’s central guide, making it easier to find contribution instructions.

@changeset-bot

changeset-bot Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3ef0a56

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The root README and package READMEs now link to the repository’s main-branch CONTRIBUTING.md instead of using relative links.

Changes: Contribution guide links

Layer / File(s) Summary
Update README contribution links
README.md, packages/*/README.md
The contribution guide links now use the repository’s GitHub URL for the main-branch CONTRIBUTING.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: kevinvandy

Merge Risk: Minimal · up to 3ef0a

This documentation-only change makes the contributing guide link work in package READMEs. It has no runtime impact and is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: the contributing guide link in package READMEs is fixed. It uses the docs prefix and is specific. The summaries show the link change in the root README and package REA…
Description check Passed The description covers the required template sections. It has a Changes section that explains the problem and the fix, which is the absolute GitHub URL in 17 package READMEs and the root README. The C…
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.
Full details: Title check

Explanation

The title names the main change: the contributing guide link in package READMEs is fixed. It uses the docs prefix and is specific. The summaries show the link change in the root README and package READMEs, which matches the title.

Full details: Description check

Explanation

The description covers the required template sections. It has a Changes section that explains the problem and the fix, which is the absolute GitHub URL in 17 package READMEs and the root README. The Checklist is complete. The Release Impact section marks the change as docs/CI/dev-only. The author did not tick the changeset box, which is correct for a docs-only change.

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.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 2ef416a and 3ef0a56.

Files selected for processing: 18

  • README.md
  • packages/alpine-table/README.md
  • packages/angular-table/README.md
  • packages/ember-table/README.md
  • packages/lit-table/README.md
  • packages/match-sorter-utils/README.md
  • packages/octane-table/README.md
  • packages/preact-table-devtools/README.md
  • packages/preact-table/README.md
  • packages/react-table-devtools/README.md
  • packages/react-table/README.md
  • packages/solid-table-devtools/README.md
  • packages/solid-table/README.md
  • packages/svelte-table/README.md
  • packages/table-core/README.md
  • packages/table-devtools/README.md
  • packages/vue-table-devtools/README.md
  • packages/vue-table/README.md
Files skipped from review as they are similar to previous changes: 17

  • packages/lit-table/README.md
  • packages/react-table-devtools/README.md
  • packages/vue-table-devtools/README.md
  • packages/preact-table/README.md
  • packages/table-core/README.md
  • packages/alpine-table/README.md
  • packages/solid-table-devtools/README.md
  • packages/vue-table/README.md
  • packages/preact-table-devtools/README.md
  • packages/solid-table/README.md
  • packages/react-table/README.md
  • packages/octane-table/README.md
  • packages/match-sorter-utils/README.md
  • packages/table-devtools/README.md
  • packages/angular-table/README.md
  • packages/ember-table/README.md
  • packages/svelte-table/README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

The root README is copied into 17 package READMEs by copy:readme.
Its relative CONTRIBUTING.md link resolves to
packages/<name>/CONTRIBUTING.md in those copies and 404s. Use the
absolute GitHub URL so the link works in the root and in every copy.

Signed-off-by: Abderrahmane Messaadi <abderrahmane8@yandex.com>
@abd1rahmane abd1rahmane changed the title docs: point package READMEs at the root contributing guide docs: make the contributing guide link work in package READMEs Nov 12, 2026
@abd1rahmane
abd1rahmane force-pushed the docs/package-readme-contributing-links branch from 2ef416a to 3ef0a56 Compare November 12, 2026 12:51

This branch has not been deployed

No deployments
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