From a7e68b53baf2809a488d45be2eda015689c9e415 Mon Sep 17 00:00:00 2001 From: Florian Scholz Date: Fri, 30 Nov 2018 16:04:03 +0100 Subject: [PATCH 1/2] Issue #2041: Add writing release notes to the publishing procedures --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 960517dbd1bfea..0b46ae120a898a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,6 +66,8 @@ Regularly, a new release of [mdn-browser-compat-data](https://www.npmjs.com/pack This step will trigger Travis to publish to npm automatically (see our [.travis.yml file](https://github.com/mdn/browser-compat-data/blob/master/.travis.yml)). 6. Check [Travis CI](https://travis-ci.org/mdn/browser-compat-data) again for the v0.0.43 build and also check [mdn-browser-compat-data on npm](https://www.npmjs.com/package/mdn-browser-compat-data) to see if `0.0.43` shows up correctly once Travis has finished its work. 7. Notify the [#mdndev](irc://irc.mozilla.org/mdndev) IRC channel on irc.mozilla.org about the new release and coordinate with jwhitlock or rjohnson a deployment of the new package to the MDN site. + 8. Create a [new release on GitHub](https://github.com/mdn/browser-compat-data/releases) and write down release notes. Mention notable changes if non-data updates happened (schema, test, or infrastructure changes). Also record current statistics such as total number of contributors and stargazers, as well as the total number of features by running this node command in the main dir: + `node -p "bcd=require('.');i=0;JSON.parse(JSON.stringify(bcd),function(k,v){if(k==='__compat'){i++;}return i;})"` ## Licensing From a377e91011140e0c361337de32b1adf366b9e53e Mon Sep 17 00:00:00 2001 From: Florian Scholz Date: Fri, 30 Nov 2018 17:51:01 +0100 Subject: [PATCH 2/2] Add release notes template --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b46ae120a898a..f9b46f4b6c4214 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,6 +69,18 @@ Regularly, a new release of [mdn-browser-compat-data](https://www.npmjs.com/pack 8. Create a [new release on GitHub](https://github.com/mdn/browser-compat-data/releases) and write down release notes. Mention notable changes if non-data updates happened (schema, test, or infrastructure changes). Also record current statistics such as total number of contributors and stargazers, as well as the total number of features by running this node command in the main dir: `node -p "bcd=require('.');i=0;JSON.parse(JSON.stringify(bcd),function(k,v){if(k==='__compat'){i++;}return i;})"` + Release notes template: + ``` +Notable changes: +- [TK text] + +Statistics: +- [TK number] contributors have changed [TK number] files with [TK number] additions and [TK number] deletions in [TK number] commits [TK link to diff between version tags] +- [TK number] total contributors +- [TK number] total stargazers +- [TK number] total features +``` + ## Licensing Please note that the compatibility data is made available under the