You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,22 @@ If you have questions about implementation details, help or support, then please
11
11
12
12
## Reporting Issues
13
13
14
-
If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/devtools/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/devtools/discussions)
14
+
If you have found what you think is a bug, first search the [open and closed issues](https://github.com/TanStack/devtools/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/devtools/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/devtools/discussions).
15
15
16
16
## Suggesting new features
17
17
18
18
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.
19
19
20
+
## Pull Request Guidelines
21
+
22
+
Every pull request must follow the [TanStack Devtools pull request template](.github/pull_request_template.md). Complete its description and checklist without removing or bypassing the required sections.
23
+
24
+
- Search the [open and closed pull requests](https://github.com/TanStack/devtools/pulls?q=is%3Apr) before starting work to avoid duplicating an existing contribution.
25
+
- 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.
26
+
- 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.
27
+
- 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.
28
+
- 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.
29
+
20
30
## Development
21
31
22
32
Before proceeding with development, ensure you match one of the following criteria:
@@ -39,6 +49,7 @@ Before proceeding with development, ensure you match one of the following criter
39
49
- To test in your own projects:
40
50
- Build/watch for changes with `pnpm build`/`pnpm dev`
41
51
- Document your changes in the appropriate documentation website markdown pages
52
+
- 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.
0 commit comments