From 3dee5b2e9453d01a3172c73426959007b290b3fc Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Mon, 24 Aug 2026 22:14:16 -0500 Subject: [PATCH] docs: clarify contribution guidelines (#8163) * docs: clarify contribution guidelines * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> --- .coderabbit.yaml | 12 ++++++++++++ .github/pull_request_template.md | 14 ++++++++++++++ AGENTS.md | 4 ++++ CONTRIBUTING.md | 13 ++++++++++++- 4 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 .coderabbit.yaml create mode 100644 .github/pull_request_template.md diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000000..21d884dbeb --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,12 @@ +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json + +reviews: + request_changes_workflow: false + slop_detection: + enabled: true + +knowledge_base: + code_guidelines: + enabled: true + filePatterns: + - 'CONTRIBUTING.md' diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..1245a0a0fd --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +## 🎯 Changes + + + +## ✅ Checklist + +- [ ] I have followed the steps in the [Contributing guide](https://github.com/TanStack/router/blob/main/CONTRIBUTING.md). +- [ ] I have tested code changes locally with the relevant test commands, or 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](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md). +- [ ] This change is docs/CI/dev-only (no release). diff --git a/AGENTS.md b/AGENTS.md index 490cb691d4..3368f3f100 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,9 @@ # AGENTS.md +Read and follow [`CONTRIBUTING.md`](./CONTRIBUTING.md) before analyzing or +changing this repository. Its contribution and pull request requirements apply +to AI-assisted work. + ## Project overview TanStack Router is a type-safe router with built-in caching and URL state management for React and Solid applications. This monorepo contains two main products: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9e793926f..ce76a5ba5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,17 @@ TanStack Router is a community project. Contributions to both TanStack Router an ## Before you start -PRs that require API changes must first be proposed as an issue and receive maintainer sign-off before implementation begins. +- Search the [open and closed issues](https://github.com/TanStack/router/issues?q=is%3Aissue) before reporting a bug. If it has not already been reported, use the [bug report template](https://github.com/TanStack/router/issues/new?template=bug_report.yml). +- Search the [open and closed pull requests](https://github.com/TanStack/router/pulls?q=is%3Apr) before starting work to avoid duplicating an existing contribution. +- Pull requests that require API changes must first be proposed as an issue and receive maintainer sign-off before implementation begins. + +## Pull request guidelines + +Every pull request must follow the [TanStack Router pull request template](.github/pull_request_template.md). Complete its description and checklist without removing or bypassing the required sections. + +- Keep each pull request focused on one change or topic. Pull requests that combine unrelated changes will be closed with a request to split them into separately reviewable contributions. +- Write a concise description that clearly explains what changed and why. Follow the sections in the pull request template; a long, unstructured description makes a contribution harder to review. +- Every change that affects a published package must include a changeset. Create it with `pnpm changeset`; documentation, CI, examples, and development-only changes do not require one. ## Development @@ -137,5 +147,6 @@ AI tools can be useful for exploring the codebase, drafting changes, and writing 1. **Keep the contribution in your own voice**. Review and rewrite generated code comments, issue reports, and pull request descriptions so they reflect what you actually mean. 2. **Keep ownership of technical decisions**. Understand every change, verify its behavior with the appropriate tests and documentation, and be ready to explain it during review. 3. **Do not paste LLM output verbatim into the codebase or a contribution**. Treat generated text and code as a draft: check its claims, adapt it to the repository, and remove anything you cannot justify. Issues or pull requests that appear to contain unreviewed LLM output may be closed without further review. +4. **Do not mass-submit unrelated or low-quality AI-generated pull requests**. We treat that behavior as spam and may close the pull requests, block the contributor, and report the GitHub account. AI-assisted contributions follow the same standards for correctness, testing, documentation, and review as every other contribution.