Merge pull request #576 from Automattic/fix/notes-about-releasing

Docs: Update notes for releasing

Author: GaryJones

.github/CONTRIBUTING.md

@@ -193,3 +193,18 @@ An example where it might not would be when a ruleset references a local sniff o
 The `composer test` or `composer ruleset` commands run the `ruleset-test.php` files (one for each standard), which internally run `phpcs` against the "dirty" test files (`ruleset-test.inc`), and looks out for a known number of errors, warnings, and messages on each line. This is then compared against the expected errors, warnings and messages to see if there are any missing or unexpected violations or difference in messages.
 
 When adding or changing a sniff, the ruleset test files should be updated to match.
+
+## Releases
+
+- In a `changelog/x.y.z` branch off of `develop`, update the `CHANGELOG.md` with a list of all of the changes following the keepachangelog.com format. Include PR references and GitHub username props.
+- Create a PR of `develop` <-- `changelog/x.y.z`, but do not merge until ready to release.
+- Create a PR of `master` <-- `develop`, and copy-paste the [`release-template.md`](https://github.com/Automattic/VIP-Coding-Standards/blob/develop/.github/ISSUE_TEMPLATE/release-template.md) contents.
+- When ready to release, merge the change log PR into `develop`, then merge the `develop` into `master` PR.
+- Tag the commit in `master` with the appropriate version number. Ideally, have it signed.
+- Close the current milestone.
+- Open a new milestone for the next release.
+- If any open PRs/issues which were milestoned for this release do not make it into the release, update their milestone.
+- Write a Lobby post to inform VIP customers about the release, including the date when the Review Bot will be updated (usually about 1.5 weeks after the VIPCS release).
+- Write an internal P2 post.
+- Open a PR to update the [Review Bot dependencies](https://github.com/Automattic/vip-go-ci/blob/master/tools-init.sh).
+

.github/ISSUE_TEMPLATE/release-template.md

@@ -9,13 +9,13 @@ assignees: GaryJones, rebeccahum
 
 ⚠️ DO NOT MERGE (YET) ⚠️
 
-Please do add approvals if you agree.
+[Remaining work for this Milestone](https://github.com/Automattic/VIP-Coding-Standards/milestone/X)
 
-PR for tracking changes for the 2.x.y release. Target release date: DOW DD MMMM.
+PR for tracking changes for the X.Y.Z release. Target release date: DOW DD MMMM YYYY.
 
-- [ ] Add changelog for this release.
+- [ ] Add change log for this release: PR #XXX
 - [ ] Merge this PR.
-- [ ] Add release tag against `master`.
+- [ ] Add signed release tag against `master`.
 - [ ] Close the current milestone.
 - [ ] Open a new milestone for the next release.
 - [ ] If any open PRs/issues which were milestoned for this release do not make it into the release, update their milestone.

README.md

@@ -1,6 +1,6 @@
 # VIP Coding Standards
 
-This project contains [PHP_CodeSniffer (PHPCS) sniffs and rulesets](https://github.com/squizlabs/PHP_CodeSniffer) to validate code developed for [WordPress.com VIP](https://wpvip.com/).
+This project contains [PHP_CodeSniffer (PHPCS) sniffs and rulesets](https://github.com/squizlabs/PHP_CodeSniffer) to validate code developed for [WordPress VIP](https://wpvip.com/).
 
 This project contains two rulesets:
 
@@ -25,14 +25,13 @@ Go to https://wpvip.com/documentation/phpcs-review-feedback/ to learn about why
 
 This will install the latest compatible versions of PHPCS and WPCS. 
 
-
 Please refer to the [installation instructions for installing PHP_CodeSniffer for WordPress.com VIP](https://wpvip.com/documentation/how-to-install-php-code-sniffer-for-wordpress-com-vip/) for more details.
 
 We recommend the [PHP_CodeSniffer Standards Composer Installer Plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer), which handles the registration of all of the installed standards, so there is no need to set the `installed_paths` config value manually, for single or multiple standards.
 
 Alternatively, you should register the standard to PHPCS by appending the VIPCS directory to the end of the installed paths. e.g.
 
-`phpcs --config-set installed_paths /path/to/wpcsstandard,path/to/vipcsstandard,etc.`
+`phpcs --config-set installed_paths /path/to/wpcsstandard,path/to/vipcsstandard`
 
 ## Contribution