From 0d6688c10f9ebd8466dcea2277c9a6d8ca8e1d4a Mon Sep 17 00:00:00 2001 From: James M Snell Date: Wed, 15 Apr 2015 08:06:45 -0700 Subject: [PATCH] doc: release-time commits Add allowance for release time commits and error corrections. Per: https://github.com/jasnell/dev-policy/issues/48#issuecomment-92867050 Example: https://github.com/iojs/io.js/pull/1421 and https://github.com/iojs/io.js/compare/fd90b33...50e9fc1. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 80f4096..cffde94 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,14 @@ All Pull Requests that either fix bugs or introduce new functionality require at Pull Requests for changes intended to improve performance require a benchmark demonstrating the performance impact. The benchmark should demonstrate improved performance after the change is applied. +### Release-related Commits and error corrections + +When cutting a new release, it is typically necessary to commit a few specific changes to the repository. These include tasks like updating the release notes and incrementing the current version number. + +It's also possible for errors to come up in the basic management of the project repository (caused either by simple human error or bugs in the tooling used to manage the project). Correction of such errors may require additional changes to be landed. + +Such changes can be landed after a significantly shorter review period if the changes are strictly targeted at repairing the current state of the repository or cutting a new release. Effort should still be made to solicit review of such changes in advance of landing them. + ### Landing Pull Requests When Landing a Pull Request, a Collaborator must modify the original commit message to include the following additional meta information regarding the change process: