Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ All development is done directly on GitHub, and all work is public.

1. Fork the repo and create your branch from default branch (usually `main`) (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
2. Run `pnpm install` to install & set up the development environment.
3. Do the changes you want and test them out in the playground app (`apps/playground`) before sending a pull request.
3. Do the changes you want
4. Build plugins with `pnpm build`
5. Test them out with `pnpm start` that uses the playground app (`app/playground`) before sending a pull request.

<br>

> WARNING<br>
> Under pnpm 10+, if you encounter sqlite3 native binding errors, workaround it by removing `withRozeniteReduxDevTools()` in `apps/playground/metro.config.js`

### Commit message convention

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
"version": "0.0.0",
"license": "MIT",
"scripts": {
"prepare": "husky"
"prepare": "husky",
"build": "nx run-many -t build",
"start": "nx start playground",
"clean": "nx reset; find . -name 'node_modules' -type d -prune -exec rm -rf '{}' + && find . -name 'dist' -type d -prune -exec rm -rf '{}' +"
},
"private": true,
"devDependencies": {
Expand Down