Skip to content

docs: clarify contribution guidelines - #358

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

docs: clarify contribution guidelines#358
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 Store. 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 issue checks, focused pull requests, responsible AI use, changesets, and development requirements.
    • Added repository-wide instructions for following contribution and submission standards.
  • Chores
    • Updated pull request checklists to support test exemptions and acknowledge AI-assisted contributions.
    • Added automated review configuration for code guidelines and slop detection.

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

nx-cloud Bot commented Aug 25, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit a83dba3

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

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

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

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: 199d382f-d9cc-4632-9157-f40f813e1401

📥 Commits

Reviewing files that changed from the base of the PR and between a83dba3 and d008cfc.

📒 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 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The changes add contribution guidance, update the pull request checklist, and configure CodeRabbit to use CONTRIBUTING.md and revised review settings.

Changes

Contribution Workflow

Layer / File(s) Summary
Contribution guidance
CONTRIBUTING.md, AGENTS.md, .github/pull_request_template.md
Adds guidance for planning work, focused changes, generated code, required checks, pull request descriptions, responsible AI use, changesets, test exemptions, and AI-assisted code acknowledgment.
Review workflow configuration
.coderabbit.yaml
Enables the CodeRabbit v2 schema, slop detection, and CONTRIBUTING.md guidelines. It disables the request-changes workflow.

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

Merge Risk: ⚪ Minimal · up to d008c

This change updates contribution guidance and review templates without changing published or runtime behavior; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description follows the repository template. It explains the documentation and review-configuration changes, completes the checklist, and identifies the change as docs/CI/dev-only.
Title check ✅ Passed The title clearly describes the primary change: clarifying contribution guidelines. It is concise and related to the changeset.
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: 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.

@pkg-pr-new

pkg-pr-new Bot commented Aug 25, 2026

Copy link
Copy Markdown
@tanstack/angular-store

npm i https://pkg.pr.new/@tanstack/angular-store@358

@tanstack/lit-store

npm i https://pkg.pr.new/@tanstack/lit-store@358

@tanstack/octane-store

npm i https://pkg.pr.new/@tanstack/octane-store@358

@tanstack/preact-store

npm i https://pkg.pr.new/@tanstack/preact-store@358

@tanstack/react-store

npm i https://pkg.pr.new/@tanstack/react-store@358

@tanstack/solid-store

npm i https://pkg.pr.new/@tanstack/solid-store@358

@tanstack/store

npm i https://pkg.pr.new/@tanstack/store@358

@tanstack/svelte-store

npm i https://pkg.pr.new/@tanstack/svelte-store@358

@tanstack/vue-store

npm i https://pkg.pr.new/@tanstack/vue-store@358

commit: d008cfc

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