Skip to content
Source
Sign inSign up
TanStack/devtools
Open History to see the last commit

CONTRIBUTING.md

53 lines2.6 KB

1---
2title: Contributing
3id: contributing
4---
5​
6# Contributing
7​
8## Questions
9​
10If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tanstack/devtools/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
11​
12## Reporting Issues
13​
14If 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)
15​
16## Suggesting new features
17​
18If 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​
20## Development
21​
22Before proceeding with development, ensure you match one of the following criteria:
23​
24- Fixing a small bug
25- Fixing a larger issue that has been previously discussed and agreed-upon by maintainers
26- Adding a new feature that has been previously discussed and agreed-upon by maintainers
27​
28## Development Workflow
29​
30- Fork this repository, we prefer the `feat-*` branch name style
31- Ensure you have `pnpm` installed
32- Install projects dependencies and linkages by running `pnpm install`
33- Auto-build and auto-test files as you edit by running `pnpm dev`
34- Implement your changes and tests
35- To run examples, follow their individual directions. Usually this includes:
36 - cd into the example directory
37 - Do NOT install dependencies again or do any linking. Nx already handles this for you. Only run install from the project root.
38 - Starting the dev server with `pnpm dev` or `pnpm start` (from the example directory)
39- To test in your own projects:
40 - Build/watch for changes with `pnpm build`/`pnpm dev`
41- Document your changes in the appropriate documentation website markdown pages
42- Commit your work and open a pull request
43- Submit PR for review
44​
45## Adding a new example
46​
47- Clone an existing example into the appropriate `examples` directory
48- Name it the example name in kebab-case
49- Update the new example's package.json to match the new example name and any other details
50- Check dependencies for unused packages
51- Install any additional packages to the example that you may need
52- Update the docs/config.json file to include the new example in the navigation sidebar
53- Commit the example eg. `docs: Add example-name`