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
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,19 +19,29 @@ To keep things organized, **please include only one icon per pull request** unle
19
19
20
20
## Contributing to packages
21
21
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.
23
23
24
24
## Contributing to documentation
25
25
26
26
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.
27
27
28
28
## Development Guide
29
29
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
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
98
108
99
109
### Testing packages
100
110
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:
102
112
103
113
```shell
104
114
# In your proicons folder
@@ -107,18 +117,18 @@ cd proicons
107
117
# Make sure to build your package when testing
108
118
pnpm run ci
109
119
110
-
bun link
120
+
pnpm link
111
121
112
122
# Create a testing folder and initialize a package
113
123
mkdir test
114
124
cdtest
115
125
116
126
117
127
# Inside your test folder
118
-
npm init
128
+
pnpm init
119
129
120
130
# Create a symbolic link to the proicons package
121
-
npm link proicons
131
+
pnpm link proicons
122
132
```
123
133
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