Skip to content

Commit 9f0bcde

Browse files
docs: address reviewer feedback on README
Co-Authored-By: [email protected] <[email protected]>
1 parent fee3b14 commit 9f0bcde

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,15 @@ Recommended for better development experience:
117117
To start developing with this repository:
118118

119119
1. Install dependencies:
120-
121120
```
122121
yarn
123122
```
124123

124+
2. Build the packages:
125+
```
126+
yarn build:dev
127+
```
128+
125129
## Building
126130

127131
Build the project using one of these commands:
@@ -210,15 +214,22 @@ Prerequisites:
210214

211215
Publishing steps:
212216

213-
1. Update dependencies: `yarn install`
214-
2. Increment version: `yarn bump`
215-
3. Build packages: `yarn build`
216-
4. Run tests:
217-
- Unit tests: `yarn test:unit`
218-
- E2E tests: `yarn test:local`
219-
5. Generate documentation: `yarn gen:docs --push`
220-
6. Publish packages: `yarn publish:packages`
221-
7. Commit with message: "Published version X.X.X"
217+
1. Create a release PR:
218+
- Create a new branch from master with format `vX.X.X-Publish`
219+
- Add changelog as PR description
220+
- Add "Release" label to the PR
221+
- Reference example: https://github.com/LIT-Protocol/js-sdk/pull/753
222+
223+
2. After PR approval, proceed with publishing:
224+
- Update dependencies: `yarn install`
225+
- Increment version: `yarn bump`
226+
- Build packages: `yarn build`
227+
- Run tests:
228+
- Unit tests: `yarn test:unit`
229+
- E2E tests: `yarn test:local`
230+
- Generate documentation: `yarn gen:docs --push`
231+
- Publish packages: `yarn publish:packages`
232+
- Commit with message: "Published version X.X.X"
222233

223234
## Testing Guide
224235

0 commit comments

Comments
 (0)