golang/go

x/review/git-codereview: package documentation for multi-commit branch workflow does not match behavior

Open

#37,038 opened on Feb 5, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsFixhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The package documentation for git-codereview says:

The 'git codereview change' command amends the top commit in the stack (HEAD).

However, CL 20049 appears to have removed this behavior, instead stating that some combination git commit --amend and git rebase should be used instead.

I'd appreciate it if these docs were updated to better explain the current behavior (potentially with an example).

I'm working on a multi-change contribution, and am finding this a little bit confusing to figure out.

Contributor guide

Research direction
Investigate the current behavior of 'git codereview change' command in multi commit branches and update the documentation accordingly.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85