Skip to content

Commit f2775db

Browse files
authored
Merge pull request #1571 from pixiv/update-contributing
docs: Update CONTRIBUTING.md
2 parents 78ae5a3 + 9cc5cea commit f2775db

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

CONTRIBUTING.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -128,18 +128,38 @@ These type definitions are authored manually by referencing the [vrm spec schema
128128

129129
## How to release
130130

131-
There is a GitHub Actions workflow called "Publish to npmjs".
131+
### Publish to npm
132+
133+
Run the workflow "Publish to npmjs": https://github.com/pixiv/three-vrm/actions/workflows/publish.yml
134+
You can trigger the workflow by clicking the "Run workflow" button at the top right of the page.
135+
132136
The workflow is defined in `.github/workflows/publish.yml`.
133137

134-
https://github.com/pixiv/three-vrm/actions/workflows/publish.yml
138+
### Merge `dev` into `release`
139+
140+
```sh
141+
# Assuming you are on the `dev` branch
142+
git pull
143+
git switch release
144+
git pull
145+
git merge dev
146+
git push
147+
git switch dev
148+
```
149+
150+
### Add a release note
151+
152+
Add a release note: https://github.com/pixiv/three-vrm/releases
153+
154+
Copying the release note from the previous release helps you to create a new release note.
155+
156+
### Manage milestones
135157

136-
After the workflow done, don't forget to:
158+
Manage milestones: https://github.com/pixiv/three-vrm/milestones
137159

138-
- Add a release note: https://github.com/pixiv/three-vrm/releases
139-
- Manage the milestone: https://github.com/pixiv/three-vrm/milestones
140-
- Rename the existing `next` milestone to the version
141-
- Close the milestone
142-
- Open a new `next` milestone
160+
- Rename the existing `next` milestone to the version
161+
- Close the milestone
162+
- Open a new `next` milestone
143163

144164
## When you add a new package to the repository
145165

0 commit comments

Comments
 (0)