Skip to content

docs: clarify contribution guidelines - #2359

Open
KevinVandy wants to merge 2 commits into
mainfrom
docs/contributing-guidelines
Open

docs: clarify contribution guidelines#2359
KevinVandy wants to merge 2 commits into
mainfrom
docs/contributing-guidelines

Conversation

@KevinVandy

@KevinVandy KevinVandy commented Aug 25, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Clarify how to submit focused, reviewable contributions to TanStack Form. Require contributors to search for duplicates, follow the PR template, understand any AI-assisted code, and include changesets for published package changes.

Add lightweight CodeRabbit anti-slop guidance and root agent instructions so automated reviewers and coding agents use the same contributing rules.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • Tests do not apply because this pull request changes documentation and review configuration only.
  • 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

    • Added contributor guidance covering repository practices, focused changes, verification, and pull request requirements.
    • Improved issue-reporting instructions, including duplicate searches and bug report templates.
    • Clarified pull request checklist items for testing and understanding submitted code.
  • Chores

    • Added repository review configuration to standardize contribution checks and coding guidance.

@KevinVandy
KevinVandy requested a review from a team as a code owner August 25, 2026 01:55
@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d30a74e9-7ffa-413c-89f6-88b5b40e9e44

📥 Commits

Reviewing files that changed from the base of the PR and between 2e32127 and 9ead25c.

📒 Files selected for processing (1)
  • .coderabbit.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .coderabbit.yaml

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds repository contribution instructions, updates issue and pull request guidance, revises the pull request checklist, and adds CodeRabbit configuration.

Changes

Contribution guidance

Layer / File(s) Summary
Contribution and pull request rules
CONTRIBUTING.md, AGENTS.md, .github/pull_request_template.md
Contributor guidance now covers issue searches, templates, focused changes, generated code, required checks, descriptions, AI-generated code, spam prevention, and changesets. The pull request checklist reflects these requirements.
CodeRabbit review configuration
.coderabbit.yaml
Added schema metadata, review workflow settings, slop detection, and CONTRIBUTING.md as the code-guideline source.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 9ead2

This documentation-only change introduces no actionable merge-blocking risk and is merge-ready after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description includes all required sections. It explains the documentation and review-configuration changes, confirms the contribution checklist, documents why tests do not apply, and states that t…
Title check ✅ Passed The title clearly summarizes the main change: clarifying contribution guidelines and related documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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: Description check

Explanation

The description includes all required sections. It explains the documentation and review-configuration changes, confirms the contribution checklist, documents why tests do not apply, and states that the change has no release impact.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/contributing-guidelines

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.

@nx-cloud

nx-cloud Bot commented Aug 25, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 9ead25c

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 1m View ↗
nx run-many --target=build --exclude=examples/** ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-25 01:59:25 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new

pkg-pr-new Bot commented Aug 25, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@2359

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@2359

@tanstack/form-devtools

npm i https://pkg.pr.new/@tanstack/form-devtools@2359

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@2359

@tanstack/preact-form

npm i https://pkg.pr.new/@tanstack/preact-form@2359

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@2359

@tanstack/react-form-devtools

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

@tanstack/react-form-nextjs

npm i https://pkg.pr.new/@tanstack/react-form-nextjs@2359

@tanstack/react-form-remix

npm i https://pkg.pr.new/@tanstack/react-form-remix@2359

@tanstack/react-form-start

npm i https://pkg.pr.new/@tanstack/react-form-start@2359

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@2359

@tanstack/solid-form-devtools

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

@tanstack/svelte-form

npm i https://pkg.pr.new/@tanstack/svelte-form@2359

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@2359

commit: 9ead25c

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