Code Review Process

​

Code Review Configuration

​

Code Review Workflow

git checkout master
git pull
git checkout -b my-feature

go test ./...

go fmt ./...
go vet ./...
go test -race ./...

git commit -m "package: brief description

Longer explanation of the change and why it's needed.

Fixes #12345"

git codereview mail

# Make changes based on feedback
git commit --amend
git codereview mail

​

Review Guidelines

​

For Contributors

• Be responsive: Reply to review comments promptly
• Be open to feedback: Reviewers are helping improve the code
• Keep changes focused: Each change should address one issue or feature
• Write clear descriptions: Explain what and why, not just how

​

For Reviewers

• Be constructive: Provide helpful suggestions, not just criticism
• Be thorough: Check for correctness, style, and test coverage
• Be timely: Try to review changes within a reasonable timeframe
• Be respectful: Remember there’s a person behind the code

​

Code Style

​

Common Review Comments

​

Error Handling

// Good
if err != nil {
    return fmt.Errorf("failed to process: %w", err)
}

// Avoid
if err != nil {
    panic(err)
}

​

Documentation

// Good: Complete sentence starting with function name
// ProcessData analyzes the input data and returns results.
func ProcessData(data []byte) (Result, error) {

// Avoid: Incomplete or missing documentation
func ProcessData(data []byte) (Result, error) {

​

Additional Resources

• Go Code Review Comments
• Effective Go
• Contribution Guidelines