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: content/docs/contribute/www.mdx
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Before you begin, make sure you have the following installed on your machine:
11
11
12
12
-[**Git**](https://git-scm.com/): Version control system to clone the repository and manage your code.
13
13
-[**Node.js**](https://nodejs.org/): JavaScript runtime for running the development server and building the project.
14
-
-[**npm**](https://www.npmjs.com/): Node package manager, which comes with Node.js.
14
+
-[**pnpm**](https://pnpm.io/): Fast, disk-efficient Node package manager used by this project.
15
15
16
16
## Step 1: Fork the Repository
17
17
@@ -34,17 +34,17 @@ Replace `<your-username>` with your GitHub username.
34
34
Navigate to the project directory and install the required dependencies:
35
35
36
36
```bash
37
-
npm install
37
+
pnpm install
38
38
```
39
39
40
-
This command installs all the necessary packages listed in the `package.json` file.
40
+
This command installs all the necessary packages listed in the `package.json` file and respects the exact versions defined in `pnpm-lock.yaml`.
41
41
42
42
## Step 4: Build the Project
43
43
44
44
To build the project files:
45
45
46
46
```bash
47
-
npm run build
47
+
pnpm run build
48
48
```
49
49
50
50
This command will compile and process all the source files into a production-ready format.
@@ -54,7 +54,7 @@ This command will compile and process all the source files into a production-rea
54
54
After installing the dependencies, you can start the development server:
55
55
56
56
```bash
57
-
npm run dev
57
+
pnpm run dev
58
58
```
59
59
60
60
This command will start a local server and open the homepage in your default web browser. The server will automatically reload whenever you make changes to the code.
@@ -75,11 +75,16 @@ Before submitting your changes, make sure they work as expected. Check the funct
75
75
76
76
## Step 8: Commit and Push Your Changes
77
77
78
-
Once you are satisfied with your changes, commit them to your local repository:
78
+
Once you are satisfied with your changes, commit them to your local repository. **All commits must:**
79
+
80
+
1. Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification (checked automatically by **commitlint**).
81
+
2. Commits must be signed. You can learn more about Commit Signing [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
0 commit comments