Skip to content

Commit a497442

Browse files
committed
Docs: Move RELEASE.md into CONTRIBUTING.md
1 parent 0a965d7 commit a497442

3 files changed

Lines changed: 32 additions & 41 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
1+
# Contributing
2+
3+
Please see the [Contributing to Grunt](https://gruntjs.com/contributing) guide for information on contributing to this project.
4+
15
## Release process
26

3-
1. Set next version in `package.json`.
4-
2. Write section in `CHANGELOG.md` with high-level changes,
5-
limited to what is relevant and observable to users of the package.
6-
3. Commit to Git and push to a temporary branch (e.g. `release`).
7-
4. Wait for and confirm that CI passes.
8-
5. Push to main, and delete the `release` branch on GitHub.
9-
6. Create and push git tag.
10-
7. Run `npm publish`
7+
### Before the release
8+
9+
* Land relevant changes.
10+
* Ensure CI is passing.
1111

12-
## See also
12+
### Publish
1313

14-
* [Contributing to grunt](https://gruntjs.com/contributing)
14+
1. Set the new version in `package.json`.
15+
2. Write section in `CHANGELOG.md` file.
16+
Include only high-level changes that are relevant and observable to users of the package.
17+
3. Stage and locally commit.
18+
```
19+
git add -p && git commit -m $NEW_VERSION
20+
```
21+
4. Create the tag.
22+
```
23+
git tag -s v${NEW_VERSION} -m $NEW_VERSION
24+
```
25+
5. Push commit and tag.
26+
```
27+
git push --follow-tags
28+
```
29+
6. Publish package.
30+
```
31+
npm publish
32+
```

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
[![Build Status](https://github.com/gruntjs/grunt-contrib-qunit/workflows/Tests/badge.svg)](https://github.com/gruntjs/grunt-contrib-qunit/actions?workflow=Tests)
1+
[![npm](https://img.shields.io/npm/v/grunt-contrib-qunit.svg?style=flat)](https://www.npmjs.com/package/grunt-contrib-qunit)
2+
[![Build Status](https://github.com/gruntjs/grunt-contrib-qunit/workflows/Tests/badge.svg)](https://github.com/gruntjs/grunt-contrib-qunit/actions?workflow=Tests)
3+
[![Built with Grunt](https://gruntjs.com/builtwith.svg)](https://gruntjs.com/)
4+
[![Tested with QUnit](https://qunitjs.com/testedwith.svg)](https://qunitjs.com/)
25

36
# grunt-contrib-qunit
47

@@ -18,7 +21,6 @@ Once the plugin has been installed, it may be enabled inside your Gruntfile with
1821
grunt.loadNpmTasks('grunt-contrib-qunit');
1922
```
2023

21-
2224
## QUnit task
2325

2426
_Run this task with the `grunt qunit` command._

RELEASE.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)