Skip to content

Commit 0f53054

Browse files
committed
doc/contrib: update git codereview change to use -s flag
git-codereview learned about -s in: golang/review@2e4fd9a Update our contributing docs to reflect that. Fixes #1099 Signed-off-by: Paul Jolly <[email protected]> Change-Id: I7d7baeee03ecce074d2abdfd1a987e3d87cecea8 Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/521474
1 parent ecb17c9 commit 0f53054

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/contribute.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -338,31 +338,31 @@ will create or amend a single commit in the branch.
338338
$ git checkout -b mybranch
339339
$ [edit files...]
340340
$ git add [files...]
341-
$ git codereview change # create commit in the branch
341+
$ git codereview change -s # create commit in the branch
342342
$ [edit again...]
343343
$ git add [files...]
344-
$ git codereview change # amend the existing commit with new changes
344+
$ git codereview change -s # amend the existing commit with new changes
345345
$ [etc.]
346346
```
347347

348348
- **Step 3:** Test your changes, re-running `go test`.
349349
```
350-
$ go test ./... # recompile and test
350+
$ go test ./... # recompile and test
351351
```
352352

353353
- **Step 4:** Send the changes for review to Gerrit using `git`
354354
`codereview` `mail` (which doesn't use e-mail, despite the name).
355355
```
356-
$ git codereview mail # send changes to Gerrit
356+
$ git codereview mail # send changes to Gerrit
357357
```
358358

359359
- **Step 5:** After a review, apply changes to the same single commit
360360
and mail them to Gerrit again:
361361
```
362362
$ [edit files...]
363363
$ git add [files...]
364-
$ git codereview change # update same commit
365-
$ git codereview mail # send to Gerrit again
364+
$ git codereview change -s # update same commit
365+
$ git codereview mail # send to Gerrit again
366366
```
367367

368368
The rest of this section describes these steps in more detail.
@@ -402,11 +402,11 @@ $ [edit files...]
402402
$ git add [files...]
403403
```
404404

405-
To commit changes, instead of `git commit`, use `git codereview change`.
405+
To commit changes, instead of `git commit -s`, use `git codereview change -s`.
406406

407407

408408
```
409-
$ git codereview change
409+
$ git codereview change -s
410410
(open $EDITOR)
411411
```
412412

@@ -497,9 +497,9 @@ area, and then amend the commit with
497497

498498

499499
```
500-
$ git codereview change # amend current commit
500+
$ git codereview change -s # amend current commit
501501
(open $EDITOR)
502-
$ git codereview mail # send new changes to Gerrit
502+
$ git codereview mail # send new changes to Gerrit
503503
```
504504

505505
If you don't need to change the commit description, just save and exit from the editor.

0 commit comments

Comments
 (0)