You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`rds`: Likely related to data services or storage (needs verification).
25
+
-`root-core`: Core logic/utilities.
26
+
-`root-db`: Database abstraction/layer.
27
+
-`root-form`: Form handling utilities.
28
+
-`root-password-protect`: Middleware/utility for password protection.
29
+
-`root-webui`: UI components or interface for the system.
30
30
31
31
### Apps (`apps/`)
32
32
33
33
-**gci**: An application built within the monorepo.
34
34
35
35
### Documentation (`docs/`)
36
+
36
37
Contains documentation for the project, likely powering `rootjs.dev`.
37
38
38
39
### Examples (`examples/`)
40
+
39
41
Contains example projects demonstrating various features of Root.js.
40
42
41
43
## Development
@@ -49,20 +51,26 @@ Contains example projects demonstrating various features of Root.js.
49
51
When working on this project, please adhere to the following guidelines:
50
52
51
53
### Package Management
54
+
52
55
-**Always use `pnpm`**: This project uses `pnpm` for package management. Do not use `npm` or `yarn`.
53
56
-**Install dependencies**: Run `pnpm install` at the root to install dependencies for all packages.
54
57
55
58
### Build & Test
59
+
56
60
-**Use Turbo**: Use `turbo run build` or `turbo run test` to run tasks across the monorepo efficiently.
57
61
-**Dev Server**: Use `pnpm dev` in specific package or app directories for development.
58
62
59
63
### Version Control & Contributions
64
+
60
65
-**Changesets**: If your changes require a release (version bump), you must create a changeset. Run `pnpm changeset` and follow the prompts.
61
66
-**Commit Messages**: Follow the conventional commit format (e.g., `feat: add new feature`, `fix: resolve issue`).
62
67
-**Linting**: Ensure code passes linting rules by running `pnpm lint`.
63
68
64
69
### Documentation
70
+
65
71
-**Update Docs**: If you change functionality, check if `docs/` needs updating. The documentation is a Root.js app itself.
72
+
-**Comment Style**: All comments should end in punctuation. Use block comments to describe interfaces and their fields. Avoid adding superfluous comments.
73
+
-**Comment Requirements**: When creating new classes, hooks, or components that have medium-to-complex functionality, ensure you write at least a brief block comment describing what it is for. For complex functionality, provide an example of how to use it in the comment.
0 commit comments