|
| 1 | +# Contributing to React Zero-UI |
| 2 | + |
| 3 | +**Thanks for stopping by.** This project exists because builders like you push boundaries. If you're here to experiment, break things, or ship speed — you're in the right place. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## ⚡ Core Philosophy |
| 8 | + |
| 9 | +**React Zero-UI** is built on a radical idea: |
| 10 | + |
| 11 | +> UI state should not require re-rendering. |
| 12 | +> CSS and `data-*` attributes can be enough. |
| 13 | +
|
| 14 | +It's fast because it **skips the VDOM entirely** — no state triggers, no diffing, no component redraws. |
| 15 | + |
| 16 | +### If you contribute: |
| 17 | +Stay **pre-rendered, declarative, and brutally fast.** |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 🧠 Monorepo Structure |
| 22 | + |
| 23 | +``` |
| 24 | +packages/ |
| 25 | +├── core → @austinserb/react-zero-ui (library logic + postcss) |
| 26 | +└── cli → create-zero-ui (npx installer) |
| 27 | +``` |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## ⚙️ Local Setup |
| 32 | + |
| 33 | +```bash |
| 34 | +pnpm bootstrap # builds + installs local tarball into test fixtures |
| 35 | +pnpm test # runs all tests (unit + E2E) |
| 36 | +``` |
| 37 | + |
| 38 | +> Node 18+ and PNPM required. |
| 39 | +> Run from repo root. |
| 40 | +
|
| 41 | +--- |
| 42 | + |
| 43 | +## ✅ Contribution Flow |
| 44 | + |
| 45 | +### 1. [Start a Discussion](https://github.com/Austin1serb/React-Zero-UI/discussions) |
| 46 | + |
| 47 | +For questions, proposals, or early feedback. Share ideas before building. |
| 48 | + |
| 49 | +### 2. [Open an Issue](https://github.com/Austin1serb/React-Zero-UI/issues) |
| 50 | + |
| 51 | +Use the templates. |
| 52 | + |
| 53 | +* **Bug** → Include steps to reproduce, expected vs. actual behavior. |
| 54 | +* **Feature** → Explain the *why*, and sketch a possible approach. |
| 55 | + |
| 56 | +### 3. Pull Requests |
| 57 | + |
| 58 | +* Use semantic commit prefixes: `feat:`, `fix:`, `chore:`, `refactor:` |
| 59 | +* Add tests if you touch logic, CLI, or rendering behavior. |
| 60 | +* Keep PRs focused — one change per pull. |
| 61 | +* Fill out the PR template — no empty descriptions. |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +## 🧪 Test Commands |
| 66 | + |
| 67 | +```bash |
| 68 | +pnpm test:unit # Core logic tests |
| 69 | +pnpm test:cli # CLI creation flow |
| 70 | +pnpm test:vite # E2E tests on Vite fixture |
| 71 | +pnpm test:next # E2E tests on Next.js fixture |
| 72 | +pnpm test # Runs all of the above |
| 73 | +``` |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## 🤝 Code of Conduct |
| 78 | + |
| 79 | +Keep it respectful. Push ideas hard, not people. |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## 📬 Contact |
| 84 | + |
| 85 | +> Got a big idea? DM me: |
| 86 | +> [linkedin.com/in/austin-serb](https://www.linkedin.com/in/austin-serb/) |
| 87 | +
|
0 commit comments