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
+27-10Lines changed: 27 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ Welcome to the ml5.js project! Developing ml5.js is not just about developing ma
16
16
-[For Command Line](#for-command-line)
17
17
-[Building the Library](#building-the-library)
18
18
-[Making Releases](#making-releases)
19
+
-[Release Notes](#release-notes)
19
20
-[Unit Tests](#unit-tests)
20
21
-[Update p5 Web Editor Sketches](#update-p5-web-editor-sketches)
21
22
-[All Contributors](#all-contributors)
@@ -156,44 +157,60 @@ This will create a production version of the library in `/dist` directory.
156
157
157
158
3. Commit the changes. Then, make a pull request from the new branch to main and merge it.
158
159
159
-
4. Switch to the main branch and make sure the code is up to date by running the following command:
160
+
4. Make a release note about the new release on GitHub. Check the [Release Notes](#release-notes) section for detailed instruction.
161
+
162
+
5. Switch to the main branch and make sure the code is up to date by running the following command:
160
163
161
164
```
162
165
git checkout main
163
166
git pull
164
167
```
165
168
166
-
5. Make sure all dependencies have been installed by running the following command:
169
+
6. Make sure all dependencies have been installed by running the following command:
167
170
168
171
```
169
172
yarn
170
173
```
171
174
172
-
6. Build the project with the following command and wait for the build to complete:
175
+
7. Build the project with the following command and wait for the build to complete:
173
176
174
177
```
175
178
yarn run build
176
179
```
177
180
178
-
7. Run the following command and log in with an npm account that has write access to the `ml5` package. You may be redirected to a browser window for authentication.
181
+
8. Run the following command and log in with an npm account that has write access to the `ml5` package. You may be redirected to a browser window for authentication.
179
182
180
183
```
181
184
npm login
182
185
```
183
186
184
-
8. Publish the package with the following command. You may be redirected to a browser window for authentication.
187
+
9. Publish the package with the following command. You may be redirected to a browser window for authentication.
185
188
186
189
```
187
190
npm publish --access public
188
191
```
189
192
190
-
9. The package should now be available at. (Replace `<version>` with the new SemVer set in step 1).
193
+
10. The package should now be available at. (Replace `<version>` with the new SemVer set in step 1).
191
194
192
-
```
193
-
https://unpkg.com/ml5@<version>/dist/ml5.js
194
-
```
195
+
```
196
+
https://unpkg.com/ml5@<version>/dist/ml5.js
197
+
```
198
+
199
+
11. Update the example code on the p5 web editor. Follow the instructions in the [Update p5 Web Editor Sketches](#update-p5-web-editor-sketches) section.
200
+
201
+
## Release Notes
202
+
203
+
ml5.js produce release notes alongside each new release. The release notes provides a brief overview of the changes, updates, and additions made to the ml5.js library. This section is a brief guide on generating release notes on GitHub.
195
204
196
-
10. Update the example code on the p5 web editor. Follow the instructions in the [Update p5 Web Editor Sketches](#update-p5-web-editor-sketches) section.
205
+
1. Go to [ml5's Releases Page](https://github.com/ml5js/ml5-next-gen/releases) on Github.
206
+
2. Click on **Draft a new release**.
207
+
3. Click on **Choose a tag** and enter the version number of the new release in the format of `v<major>.<minor>.<patch>`. For example, `v1.0.3`.
208
+
4. Click on **Create new tag: vx.x.x on publish**.
209
+
5. For the **Target**, make sure `main` is selected.
210
+
6. For the **Previous tag**, select the previous release. For example, if the new release is `v1.0.3`, select tag `v1.0.2`.
211
+
7. Click on **Generate release notes**, and a release note will be automatically generated. If needed, make manual edits to the release note.
212
+
8. Make sure **Set as the latest release** is selected and click **Publish release**.
0 commit comments