Skip to content

Commit 0f7391b

Browse files
Update contribution guide to fix package manager references and add tech stack details
1 parent b8e024b commit 0f7391b

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,29 @@ To keep things organized, **please include only one icon per pull request** unle
1919

2020
## Contributing to packages
2121

22-
The main ProIcons package is inside of the root `src` folder. Other packages are available in the `packages` folder. We use [Bun workspaces](https://bun.com/docs/pm/workspaces) to manage and distribute multiple packages in a single monorepo.
22+
The main ProIcons package is inside of the root `src` folder. Other packages are available in the `packages` folder. We use [PNPM workspaces](https://pnpm.io/workspaces) to manage and distribute multiple packages in a single monorepo.
2323

2424
## Contributing to documentation
2525

2626
The ProIcons documentation is built using [VitePress](https://vitepress.dev). The Markdown files are located in the [site/src/docs](https://github.com/ProCode-Software/proicons/tree/main/site/src/docs) folder.
2727

2828
## Development Guide
2929

30+
### Tech Stack
31+
- [Bun](https://bun.com) as a runtime
32+
- [PNPM](https://pnpm.io) as a package manager
33+
- The codebase is written in [TypeScript](https://typescriptlang.org)
34+
- [tsgo](https://github.com/microsoft/typescript-go) for .dts generation
35+
- [Vite](https://vite.dev) with [Rolldown](https://rolldown.rs) for bundling
36+
- [VitePress](https://vitepress.dev) for documentation
37+
- [Oxc](https://oxc.rs) for code formatting
38+
3039
### Getting the repo
3140

3241
#### Prerequisites
3342

3443
- [Node.js](https://nodejs.org) 22+
44+
- [PNPM](https://pnpm.io) 10+
3545
- [Bun](https://bun.com)
3646

3747
First, clone the repository:
@@ -43,7 +53,7 @@ git clone https://github.com/ProCode-Software/proicons.git
4353
Then install dependencies
4454

4555
```
46-
bun install
56+
pnpm install
4757
```
4858

4959
The command above will install dependencies for all packages. If you want to install dependencies for a specific package, run `pnpm --filter [package] install`.
@@ -98,7 +108,7 @@ Run `pnpm run icons:build` in the `proicons` folder to create PNG and SVG files
98108

99109
### Testing packages
100110

101-
To ensure your changes work, test your changes. This can be done by creating a separate test project and creating a symlink to your modified version using `npm link` as shown below:
111+
To ensure your changes work, test your changes. This can be done by creating a separate test project and creating a symlink to your modified version using `pnpm link` as shown below:
102112

103113
```shell
104114
# In your proicons folder
@@ -107,18 +117,18 @@ cd proicons
107117
# Make sure to build your package when testing
108118
pnpm run ci
109119

110-
bun link
120+
pnpm link
111121

112122
# Create a testing folder and initialize a package
113123
mkdir test
114124
cd test
115125

116126

117127
# Inside your test folder
118-
npm init
128+
pnpm init
119129

120130
# Create a symbolic link to the proicons package
121-
npm link proicons
131+
pnpm link proicons
122132
```
123133

124-
Replace `proicons` in the `npm link` command with the package you want to test.
134+
Replace `proicons` in the `pnpm link` command with the package you want to test.

0 commit comments

Comments
 (0)