docs: add contributing guide#1620
Open
KyleAMathews wants to merge 2 commits into
Open
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a CONTRIBUTING guide covering support channels, issue and feature submission, development commands, local docs editing and previewing, example runs, Changesets usage, PR squashing, and the preview/publish release flow. ChangesContribution documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
More templates
@tanstack/angular-db
@tanstack/browser-db-sqlite-persistence
@tanstack/capacitor-db-sqlite-persistence
@tanstack/cloudflare-durable-objects-db-sqlite-persistence
@tanstack/db
@tanstack/db-ivm
@tanstack/db-sqlite-persistence-core
@tanstack/electric-db-collection
@tanstack/electron-db-sqlite-persistence
@tanstack/expo-db-sqlite-persistence
@tanstack/node-db-sqlite-persistence
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/react-native-db-sqlite-persistence
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/tauri-db-sqlite-persistence
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Contributor
|
Size Change: 0 B Total Size: 123 kB ℹ️ View Unchanged
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 92-98: The fenced example block in CONTRIBUTING.md is missing a
language label, which will trip the markdownlint MD040 check. Update the fenced
block that shows the tanstack directory tree to use an appropriate label such as
text so the markdown formatter recognizes it; locate the unlabeled fence in the
example section and adjust only that fence marker.
- Around line 28-30: The CONTRIBUTING setup command is incomplete because
corepack prepare is missing the pinned package manager/version. Update the
documented Corepack command to explicitly prepare the project’s required package
manager version (using the same pinned version used elsewhere in the repo) so
setup is deterministic. Keep the change in the CONTRIBUTING.md example and
ensure the command matches the project’s package manager configuration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Contributor
|
Size Change: 0 B Total Size: 4.24 kB ℹ️ View Unchanged
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a root
CONTRIBUTING.mdfor TanStack DB, following the common structure used across other TanStack repos and adapting it to this repo's commands and docs layout. Contributors now have a clear entry point for questions, issues, local setup, docs previewing, examples, changesets, and PR/release expectations.Approach
This PR pulls in the standard TanStack contributing-doc shape rather than inventing a new one:
pnpm,corepack, and.nvmrcpackage.jsonTanStack/dband../db/docsThe README already links to
CONTRIBUTING.md, so adding this file makes that existing contributor path resolve to useful setup instructions.Key Invariants
pnpm build,pnpm test, andpnpm lint.db, so tanstack.com can find../db/docsduring local development.Non-goals
Trade-offs
The guide is adapted from the shared TanStack convention instead of copied verbatim from a single repo. That keeps the familiar contributor flow while avoiding inaccurate project-specific details like another repo's package manager version, docs URL, or build/test tooling.
Verification
Not run, because this is a docs-only change and the edited file is Markdown contributor guidance:
pnpm testFiles changed
CONTRIBUTING.md— new contributor guide covering support channels, issue/feature flow, local development setup, docs previewing, examples, changesets, PR expectations, and releases.Preserved from the previous PR body / CodeRabbit summary:
Summary by CodeRabbit