Skip to content

Commit 844b9a9

Browse files
authored
Add CONTRIBUTING.md. (#216)
1 parent 4e177da commit 844b9a9

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to electron-trpc
2+
3+
We welcome contributions from the community. This guide assumes you're familiar with Git, GitHub, and pnpm.
4+
5+
## Quick Start
6+
7+
1. Fork and clone the repository
8+
2. Install dependencies: `pnpm install`
9+
3. Create a new branch for your feature
10+
4. Make changes and commit
11+
5. Run tests: `pnpm test`
12+
6. Create a changeset: `pnpm changeset`
13+
7. Push to your fork and submit a pull request
14+
15+
## Monorepo Structure
16+
17+
This project uses a pnpm monorepo structure. The main directories are:
18+
19+
- `examples/`: Contains examples of various use-cases and serves as the basis for e2e tests
20+
- `packages/`: Houses the main electron-trpc package
21+
22+
## Scripts
23+
24+
These are the most likely scripts you'll want to use during development:
25+
26+
- `pnpm install`: Install dependencies for all packages
27+
- `pnpm test`: Run tests across all packages
28+
- `pnpm test:e2e`: Run end-to-end tests
29+
- `pnpm build`: Build all packages
30+
- `pnpm changeset`: Create a changeset for your changes
31+
32+
## Reporting Issues
33+
34+
Open an issue on GitHub for bugs or suggestions.
35+
36+
## License
37+
38+
By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)