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
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,20 @@ We want this community to be friendly and respectful to each other. Please follo
6
6
7
7
## Development workflow
8
8
9
-
This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
9
+
This project is a monorepo managed using [Bun workspaces](https://bun.sh/docs/install/workspaces). It contains the following packages:
10
10
11
11
- The library package in the root directory.
12
12
- An example app in the `example/` directory.
13
13
14
14
To get started with the project, make sure you have the correct version of [Node.js](https://nodejs.org/) installed. See the [`.nvmrc`](./.nvmrc) file for the version used in this project.
15
15
16
-
Run `yarn` in the root directory to install the required dependencies for each package:
16
+
Run `bun install` in the root directory to install the required dependencies for each package:
17
17
18
18
```sh
19
-
yarn
19
+
bun install
20
20
```
21
21
22
-
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli)for development without manually migrating.
22
+
> Since the project relies on Bun workspaces, you cannot use [`npm`](https://github.com/npm/cli)or [`yarn`](https://yarnpkg.com/) for development.
23
23
24
24
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
25
25
@@ -34,19 +34,19 @@ You can use various commands from the root directory to work with the project.
34
34
To start the packager:
35
35
36
36
```sh
37
-
yarn example start
37
+
bun example start
38
38
```
39
39
40
40
To run the example app on Android:
41
41
42
42
```sh
43
-
yarn example android
43
+
bun example android
44
44
```
45
45
46
46
To run the example app on iOS:
47
47
48
48
```sh
49
-
yarn example ios
49
+
bun example ios
50
50
```
51
51
52
52
To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:
@@ -60,25 +60,25 @@ Note the `"fabric":true` and `"concurrentRoot":true` properties.
60
60
Make sure your code passes TypeScript:
61
61
62
62
```sh
63
-
yarn typecheck
63
+
bun typecheck
64
64
```
65
65
66
66
To check for linting errors, run the following:
67
67
68
68
```sh
69
-
yarn lint
69
+
bun lint
70
70
```
71
71
72
72
To fix formatting errors, run the following:
73
73
74
74
```sh
75
-
yarn lint --fix
75
+
bun lint --fix
76
76
```
77
77
78
78
Remember to add tests for your change if possible. Run the unit tests by:
79
79
80
80
```sh
81
-
yarntest
81
+
buntest
82
82
```
83
83
84
84
@@ -103,21 +103,21 @@ We use [release-it](https://github.com/release-it/release-it) to make it easier
103
103
To publish new versions, run the following:
104
104
105
105
```sh
106
-
yarn release
106
+
bun run release
107
107
```
108
108
109
109
110
110
### Scripts
111
111
112
112
The `package.json` file contains various scripts for common tasks:
113
113
114
-
-`yarn`: setup project by installing dependencies.
115
-
-`yarn typecheck`: type-check files with TypeScript.
116
-
-`yarn lint`: lint files with [ESLint](https://eslint.org/).
117
-
-`yarn test`: run unit tests with [Jest](https://jestjs.io/).
118
-
-`yarn example start`: start the Metro server for the example app.
119
-
-`yarn example android`: run the example app on Android.
120
-
-`yarn example ios`: run the example app on iOS.
114
+
-`bun install`: setup project by installing dependencies.
115
+
-`bun typecheck`: type-check files with TypeScript.
116
+
-`bun lint`: lint files with [ESLint](https://eslint.org/).
117
+
-`bun test`: run unit tests with [Jest](https://jestjs.io/).
118
+
-`bun example start`: start the Metro server for the example app.
119
+
-`bun example android`: run the example app on Android.
0 commit comments