Skip to content

docs: missing CONTRIBUTING.md (referenced from README and PR template) #514

@arnthors

Description

@arnthors

Summary

The repo lacks a top-level CONTRIBUTING.md, but two places in the repo link to one:

  • README.md: "See CONTRIBUTING.md for setup instructions" — broken in-repo link.
  • .github/pull_request_template.md: "I have followed the steps in the Contributing guide" — 404s on GitHub. The template's first checkbox is therefore impossible to honestly satisfy.

Sister repos

Most TanStack repos ship one:

  • TanStack/query
  • TanStack/router
  • TanStack/table
  • TanStack/form
  • TanStack/start ❌ (also missing)

Suggested fix

Add a CONTRIBUTING.md based on TanStack/query's, with this repo's specifics:

  • pnpm@10.17.0 (enforced via packageManager)
  • Node version pinned in .nvmrc (24.8.0)
  • pnpm install then pnpm build:all (required before running examples — workspace packages have no dist until built)
  • E2E suite at testing/e2e/ is mandatory per CLAUDE.md
  • pnpm changeset for changes to publishable packages; private example packages don't need one
  • pnpm run test:pr as the per-PR validation entrypoint

Happy to open a PR if maintainers want.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions