Skip to content

Commit 0537b51

Browse files
committed
Added maintainer memo
1 parent 8282bad commit 0537b51

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ examples/
44
.prettierrc
55
.github/
66
src/*.test.js
7+
RELEASE.rst

RELEASE.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Things to do while releasing a new version
2+
==========================================
3+
4+
This file is a memo for the maintainer.
5+
6+
7+
0. Checks
8+
---------
9+
10+
* Check Copyright years in the LICENSE file
11+
* Check there will be no trash in the package (``npm pack``)
12+
13+
14+
1. Release
15+
----------
16+
17+
* Update version number in ``package.json``
18+
* Edit / update changelog in ``README.md``
19+
* Commit / tag (``git commit -m vX.Y.Z && git tag vX.Y.Z && git push && git push --tags``)
20+
21+
22+
2. Publish NPM package
23+
-----------------------
24+
25+
* ``npm publish``
26+
27+
28+
3. Publish Github Release
29+
-------------------------
30+
31+
* Make a release on Github
32+
* Add changelog

0 commit comments

Comments
 (0)