Skip to content

Commit 46da5f5

Browse files
committed
[readme] move maintainer instructions to CONTRIBUTING.md
1 parent 64e2a03 commit 46da5f5

File tree

2 files changed

+23
-22
lines changed

2 files changed

+23
-22
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
## For maintainers
4+
5+
### How to publish a new release
6+
7+
1. On the `main` branch, bump the version number in `package.json`:
8+
9+
```sh
10+
npm version patch
11+
```
12+
13+
Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
14+
15+
Note that this produces a Git commit + tag.
16+
17+
1. Push the release commit and tag:
18+
19+
```sh
20+
git push && git push --tags
21+
```
22+
23+
Our CI then automatically publishes the new release to npm.

README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,28 +44,6 @@ var endsWith = require('string.prototype.endswith');
4444

4545
Polyfills + test suites for [`String.prototype.startsWith`](https://mths.be/startswith) and [`String.prototype.contains`](https://mths.be/contains) are available, too.
4646

47-
## For maintainers
48-
49-
### How to publish a new release
50-
51-
1. On the `main` branch, bump the version number in `package.json`:
52-
53-
```sh
54-
npm version patch
55-
```
56-
57-
Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
58-
59-
Note that this produces a Git commit + tag.
60-
61-
1. Push the release commit and tag:
62-
63-
```sh
64-
git push && git push --tags
65-
```
66-
67-
Our CI then automatically publishes the new release to npm.
68-
6947
## Author
7048

7149
| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |

0 commit comments

Comments
 (0)