Skip to content

Commit 36d69a9

Browse files
committed
docs: updated contrib and code of conduct guide
1 parent 62e43b7 commit 36d69a9

2 files changed

Lines changed: 32 additions & 8 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ representative at an online or offline event.
6161

6262
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6363
reported to the community leaders responsible for enforcement at
64-
[INSERT CONTACT METHOD].
64+
https://forms.gle/4PBwYdCWGLokBbGP7.
6565
All complaints will be reviewed and investigated promptly and fairly.
6666

6767
All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,44 @@ Contributions are always welcome, no matter how large or small!
44

55
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
66

7-
## Development workflow
7+
## Development Workflow
88

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 [Yarn Workspaces](https://yarnpkg.com/features/workspaces) with Yarn 4.9.2. It contains the following packages:
1010

1111
- The library package in the root directory.
1212
- An example app in the `example/` directory.
1313

14-
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
14+
To get started with the project, follow these steps:
1515

16-
```sh
17-
yarn
18-
```
16+
1. **Ensure Node.js is installed**: Use Node.js 22.12.0 or higher (as specified in `.nvmrc`). Install via [nvm](https://github.com/nvm-sh/nvm) if needed:
17+
18+
```sh
19+
nvm install 22.12.0
20+
nvm use 22.12.0
21+
```
22+
23+
2. **Enable Corepack**: Yarn 4.9.2 is managed via Corepack, included with Node.js. Enable it to ensure the correct Yarn version:
24+
25+
```sh
26+
corepack enable
27+
corepack prepare yarn@4.9.2 --activate
28+
```
29+
30+
3. Set up Yarn configuration: In the root directory, configure Yarn 4.9.2 and generate the .yarnrc.yml file:
31+
32+
```sh
33+
yarn set version 4.9.2
34+
yarn config set nodeLinker node-modules
35+
yarn config set nmHoistingLimits workspaces
36+
```
37+
38+
4. **Install dependencies**: Install dependencies for all packages:
39+
40+
```sh
41+
yarn
42+
```
1943

20-
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
44+
> Important: This project relies on Yarn Workspaces and Yarn 4.9.2. Do not use npm or other package managers for development, as they are not compatible with the monorepo setup.
2145
2246
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
2347

0 commit comments

Comments
 (0)