Skip to content

Commit 7dc665c

Browse files
committed
docs: add contributing guide
1 parent cbbe336 commit 7dc665c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to React Code View
2+
3+
Thanks for helping improve React Code View! This guide keeps contributions consistent and easy to review.
4+
5+
## Prerequisites
6+
- Node.js 18+
7+
- PNPM 9 (Corepack enabled: `corepack enable`)
8+
- Git
9+
10+
## Setup
11+
```bash
12+
corepack enable
13+
pnpm install
14+
```
15+
16+
## Common Tasks
17+
- Typecheck: `pnpm -w typecheck`
18+
- Lint: `pnpm -w lint`
19+
- Test: `pnpm -w test`
20+
- Build: `pnpm -w build`
21+
- Docs dev: `pnpm docs`
22+
- Docs build: `pnpm docs:build`
23+
24+
## Development Notes
25+
- Monorepo is managed with PNPM + Turbo; prefer `pnpm -w <script>` for workspace-wide tasks.
26+
- Avoid committing generated bundles in `dist/`; keep changes to source and configs.
27+
- Ensure tests pass locally before opening a PR.
28+
- Update or add tests for behavior changes (see `packages/**/__tests__`).
29+
30+
## Changesets & Releases
31+
- For user-visible changes, run `pnpm changeset` and follow the prompts (choose the affected packages and bump type).
32+
- Keep the summary short and mention breaking changes clearly.
33+
- Versioning and publishing are handled via CI; tags trigger the publish workflow.
34+
35+
## Pull Requests
36+
- Base your work on the latest `main` (or the active release branch) and keep commits focused.
37+
- Describe the change, rationale, and testing performed.
38+
- If you add a new feature or breaking change, update `README.md` and relevant docs.
39+
40+
## Coding Style
41+
- TypeScript everywhere; prefer explicit types on public APIs.
42+
- React 18 conventions (hooks, function components).
43+
- Keep imports sorted logically; run linters/formatters as needed.
44+
45+
## Need Help?
46+
- Open a discussion or issue in the repo with reproduction steps and context.

0 commit comments

Comments
 (0)