From 822b2cbb33c5e15c429598840310cfd8c14a4f5f Mon Sep 17 00:00:00 2001 From: Bill Thiede Date: Thu, 3 Jul 2014 17:42:23 -0400 Subject: [PATCH] doc/contribute: reorder documented steps to match normal workflow. LGTM=adg R=golang-codereviews, bradfitz, adg CC=golang-codereviews https://golang.org/cl/109970043 --- doc/contribute.html | 168 ++++++++++++++++++++++---------------------- 1 file changed, 84 insertions(+), 84 deletions(-) diff --git a/doc/contribute.html b/doc/contribute.html index 3927349850..32ff09bdd3 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -312,6 +312,90 @@ which hg change will print, something like: CL created: https://codereview.appspot.com/99999 +

Mail the change for review

+ +

+Creating or uploading the change uploads a copy of the diff to the code review server, +but it does not notify anyone about it. To do that, you need to run hg mail +(see below). +

+ +

To send out a change for review, run hg mail using the change list number +assigned during hg change:

+ +
+$ hg mail 99999
+
+ +

You can add to the Reviewer: and CC: lines +using the -r or --cc options. +In the above example, we could have left the Reviewer and CC +lines blank and then run: +

+ +
+$ hg mail -r golang-codereviews@googlegroups.com --cc math-nuts@swtch.com 99999
+
+ +

to achieve the same effect.

+ +

Note that -r and --cc cannot be spelled --r or -cc.

+ +

+If your change relates to an open issue, please add a comment to the issue +announcing your proposed fix, including a link to your CL. +

+ +

Reviewing code

+ +

+Running hg mail will send an email to you and the reviewers +asking them to visit the issue's URL and make comments on the change. +When done, the reviewer clicks “Publish and Mail comments” +to send comments back. +

+ + +

Revise and upload

+ +

+When you have revised the code and are ready for another round of review, +you can upload your change and send mail asking the reviewers to +please take another look (PTAL). Use the change list number +assigned during hg change +

+ +
+$ hg mail 99999
+
+ + +

+Or to upload your change without sending a notification, run +

+ +
+$ hg upload 99999
+
+ +

+You will probably revise your code in response to the reviewer comments. +You might also visit the code review web page and reply to the comments, +letting the reviewer know that you've addressed them or explain why you +haven't. When you're done replying, click “Publish and Mail comments” +to send the line-by-line replies and any other comments. +

+ +

+The reviewer can comment on the new copy, and the process repeats. +The reviewer approves the change by replying with a mail that says +LGTM: looks good to me. +

+ +

+You can see a list of your pending changes by running hg pending (hg p for short). +

+

Adding or removing files from an existing change

@@ -433,90 +517,6 @@ changes, but you may still need to run hg resolve -m to mark the conflict resolved.

-

Mail the change for review

- -

-Creating or uploading the change uploads a copy of the diff to the code review server, -but it does not notify anyone about it. To do that, you need to run hg mail -(see below). -

- -

To send out a change for review, run hg mail using the change list number -assigned during hg change:

- -
-$ hg mail 99999
-
- -

You can add to the Reviewer: and CC: lines -using the -r or --cc options. -In the above example, we could have left the Reviewer and CC -lines blank and then run: -

- -
-$ hg mail -r golang-codereviews@googlegroups.com --cc math-nuts@swtch.com 99999
-
- -

to achieve the same effect.

- -

Note that -r and --cc cannot be spelled --r or -cc.

- -

-If your change relates to an open issue, please add a comment to the issue -announcing your proposed fix, including a link to your CL. -

- -

Reviewing code

- -

-Running hg mail will send an email to you and the reviewers -asking them to visit the issue's URL and make comments on the change. -When done, the reviewer clicks “Publish and Mail comments” -to send comments back. -

- - -

Revise and upload

- -

-When you have revised the code and are ready for another round of review, -you can upload your change and send mail asking the reviewers to -please take another look (PTAL). Use the change list number -assigned during hg change -

- -
-$ hg mail 99999
-
- - -

-Or to upload your change without sending a notification, run -

- -
-$ hg upload 99999
-
- -

-You will probably revise your code in response to the reviewer comments. -You might also visit the code review web page and reply to the comments, -letting the reviewer know that you've addressed them or explain why you -haven't. When you're done replying, click “Publish and Mail comments” -to send the line-by-line replies and any other comments. -

- -

-The reviewer can comment on the new copy, and the process repeats. -The reviewer approves the change by replying with a mail that says -LGTM: looks good to me. -

- -

-You can see a list of your pending changes by running hg pending (hg p for short). -

-

Reviewing code by others

-- 2.48.1