Skip to content

Commit 61169db

Browse files
drwpowkerwanp
authored andcommitted
Add monorepo Contributing guide (openapi-ts#1726)
1 parent 335530c commit 61169db

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
Contributions are welcome! T
4+
5+
## Setup
6+
7+
This monorepo uses [pnpm workspaces](https://pnpm.io/) that lets packages pull from local versions rather than remote. After installing pnpm, running this command from the root will set everything up:
8+
9+
```sh
10+
pnpm i
11+
```
12+
13+
## Structure
14+
15+
This monorepo has 2 main sections: the `docs/` that deploy to `openapi-ts.dev`, and `packages/` which are all the npm packages. Each npm package has its own `CONTRIBUTING.md` doc that describes setup needed for that package.
16+
17+
```
18+
┬── docs/ # openapi-ts.dev
19+
20+
└── packages/
21+
├── openapi-fetch/ # openapi-fetch package
22+
├── openapi-typescript-helpers/
23+
│ # openapi-typescript package
24+
└── openapi-typescript/ # openapi-typescript package
25+
```

0 commit comments

Comments
 (0)