Skip to content

Commit 6d15d62

Browse files
committed
Contributing and developing.
1 parent dd82e79 commit 6d15d62

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -996,6 +996,17 @@ const UsersRoute = () => {
996996

997997
Wouter's motto is **"Minimalist-friendly"**.
998998

999+
## Contributing
1000+
1001+
**Architecture principles:**
1002+
1003+
- All code is written in JavaScript for full control over size optimization
1004+
- TypeScript definitions are maintained separately in `types/` directories
1005+
- `wouter-preact` reuses the same source except for `react-deps.js` (Preact-specific hooks)
1006+
- Type definitions are duplicated between packages (not ideal, but works for now)
1007+
1008+
**Development:** Launch the build watcher in a separate terminal with `npm run watch`, then run tests with `npm run test` for interactive mode or `npm run test -- --run` for a single run.
1009+
9991010
## Acknowledgements
10001011

10011012
Wouter illustrations and logos were made by [Katya Simacheva](https://simachevakatya.com/) and

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"size": "size-limit",
1414
"build": "npm run build -ws",
1515
"watch": "concurrently -n wouter,wouter-preact \"npm run -w packages/wouter watch\" \"npm run -w packages/wouter-preact watch\"",
16+
"watch-bun": "concurrently -n wouter,wouter-preact \"bun run --filter wouter watch\" \"bun run --filter wouter-preact watch\"",
1617
"lint": "eslint packages/**/*.js",
1718
"lint-types": "vitest --typecheck"
1819
},

0 commit comments

Comments
 (0)