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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,21 @@ yarn
19
19
20
20
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
21
21
22
+
This project uses Nitro Modules. If you're not familiar with how Nitro works, make sure to check the [Nitro Modules Docs](https://nitro.margelo.com/).
23
+
24
+
You need to run [Nitrogen](https://nitro.margelo.com/docs/nitrogen) to generate the boilerplate code required for this project. The example app will not build without this step.
25
+
26
+
Run **Nitrogen** in following cases:
27
+
28
+
- When you make changes to any `*.nitro.ts` files.
29
+
- When running the project for the first time (since the generated files are not committed to the repository).
30
+
31
+
To invoke **Nitrogen**, use the following command:
32
+
33
+
```sh
34
+
yarn nitrogen
35
+
```
36
+
22
37
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
23
38
24
39
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
0 commit comments