]> git.proxmox.com Git - mirror_novnc.git/blame - docs/release.txt
noVNC 1.0.0
[mirror_novnc.git] / docs / release.txt
CommitLineData
da82b342
SR
1- Decide a new version number X.Y.Z (follow SemVer)
2- Update version in package.json
3- Update version in docs/VERSION
4- Commit the change with a commit like "Release X.Y.Z"
5- Add a new release on GitHub called "vX.Y.Z", and populate it with
6 release notes of the following form (where A.B.C is the last release):
7
8Major Changes Since A.B.C
9=========================
10
11*Insert warnings here about incompatibilities*
12
13*Thanks to all the contributors who filed bugs, added features, and fixed bugs
14during this release :tada:*
15
16App-visible Changes
17-------------------
18
19- *feature* a feature which improves the app usage (#PRNUM)
20- *bugfix* a bug fix which fixes the app usage (#PRNUM)
21- *refactor* a refactor which changes the app usage (#PRNUM)
22
23Library-visible Changes
24-----------------------
25
26- *feature* a feature which improves the noVNC APIs (#PRNUM)
27- *bugfix* a bug fix which fixes the noVNC APIs (#PRNUM)
28- *refactor* a refactor which changes the noVNC APIs (#PRNUM)
29
30App-internals Changes
31---------------------
32
33- *bugfix* a bug fix with affects the internals of noVNC only (#PRNUM)
34- *refactor* a refactor which affects the internals of noVNC only (#PRNUM)