Skip to content

Commit 542f2ad

Browse files
authored
docs(www): switch contribution guide to pnpm (#202)
1 parent 5c77e99 commit 542f2ad

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

content/docs/contribute/www.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Before you begin, make sure you have the following installed on your machine:
1111

1212
- [**Git**](https://git-scm.com/): Version control system to clone the repository and manage your code.
1313
- [**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.
1515

1616
## Step 1: Fork the Repository
1717

@@ -34,17 +34,17 @@ Replace `<your-username>` with your GitHub username.
3434
Navigate to the project directory and install the required dependencies:
3535

3636
```bash
37-
npm install
37+
pnpm install
3838
```
3939

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`.
4141

4242
## Step 4: Build the Project
4343

4444
To build the project files:
4545

4646
```bash
47-
npm run build
47+
pnpm run build
4848
```
4949

5050
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
5454
After installing the dependencies, you can start the development server:
5555

5656
```bash
57-
npm run dev
57+
pnpm run dev
5858
```
5959

6060
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
7575

7676
## Step 8: Commit and Push Your Changes
7777

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).
82+
83+
Example:
7984

8085
```bash
8186
git add .
82-
git commit -m "Description of your changes"
87+
git commit -m "feat(www): add dark mode toggle"
8388
```
8489

8590
Push your changes to your forked repository:

0 commit comments

Comments
 (0)