From 9054cd8eac4282092fc2b1a8da98fbdc070833b8 Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Mon, 24 Aug 2026 20:54:13 -0500 Subject: [PATCH] docs: clarify contribution guidelines --- .coderabbit.yaml | 7 +++++++ .github/pull_request_template.md | 3 ++- AGENTS.md | 10 ++++++++++ CONTRIBUTING.md | 14 ++++++++++++-- 4 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 AGENTS.md diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 0a02ec0e..c07bdcb4 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -5,6 +5,8 @@ early_access: false reviews: profile: 'chill' request_changes_workflow: false + slop_detection: + enabled: true high_level_summary: true poem: true review_status: true @@ -23,3 +25,8 @@ reviews: - '!**/*.lock' chat: auto_reply: true +knowledge_base: + code_guidelines: + enabled: true + filePatterns: + - 'CONTRIBUTING.md' diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cc7e2238..3c1a557f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,8 @@ ## ✅ Checklist - [ ] I have followed the steps in the [Contributing guide](https://github.com/TanStack/hotkeys/blob/main/CONTRIBUTING.md). -- [ ] I have tested this code locally with `pnpm run test:pr`. +- [ ] I have tested code changes locally with `pnpm run test:pr`, or these 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 diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..af9e3543 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,10 @@ +# Agent Instructions + +Before analyzing or changing this repository, read and follow +[`CONTRIBUTING.md`](./CONTRIBUTING.md). Its contribution, development, testing, +pull request, and changeset requirements apply to AI-assisted work as well as +human-authored work. + +Keep every change focused on one topic. Understand and verify all generated +code, run the required checks, and provide a concise pull request description +that follows the repository template. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9debf1aa..ca029b30 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,12 +11,22 @@ If you have questions about implementation details, help or support, then please ## Reporting Issues -If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/hotkeys/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/hotkeys/discussions) +If you have found what you think is a bug, first search the [open and closed issues](https://github.com/TanStack/hotkeys/issues?q=is%3Aissue) to make sure it has not already been reported. If you cannot find an existing report, use the [bug report template](https://github.com/TanStack/hotkeys/issues/new?template=bug_report.yml). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/hotkeys/discussions). ## Suggesting new features If you are here to suggest a feature, first create an issue if it does not already exist. From there, we will discuss use-cases for the feature and then finally discuss how it could be implemented. +## Pull Request Guidelines + +Every pull request must follow the [TanStack Hotkeys pull request template](.github/pull_request_template.md). Complete its description and checklist without removing or bypassing the required sections. + +- Search the [open and closed pull requests](https://github.com/TanStack/hotkeys/pulls?q=is%3Apr) before starting work to avoid duplicating an existing contribution. +- 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. +- You may use AI tools to help generate code, but you remain responsible for understanding, testing, and verifying every submitted change. Do not submit unreviewed, low-quality, or irrelevant generated code. +- 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. + ## Development Before proceeding with development, ensure you match one of the following criteria: @@ -40,7 +50,7 @@ Before proceeding with development, ensure you match one of the following criter - Build/watch for changes with `pnpm build`/`pnpm dev` - Document your changes in the appropriate documentation website markdown pages - Run `pnpm test` to ensure all tests pass before committing -- Create a changeset (changelog entry) for your changes by running `pnpm changeset` +- Every change that affects a published package must include a changeset. Create the changelog entry with `pnpm changeset`; documentation, CI, and development-only changes do not require one. - Commit your work and open a pull request - Submit PR for review