PR Review Guidelines

This is a set of sources/articles that can be used to:

  • learn what standards PRs should meet
  • learn how you or your colleagues should handle PR reviews
  • reference on a PR that your comments/requirements are not only your wannabe but a general standard for code reviews in the IT industry

Standards

The Standard of Code Review
Google’s Engineering Practices documentation

Documentation

Documentation-Driven Development (DDD)
Documentation-Driven Development (DDD). GitHub Gist: instantly share code, notes, and snippets.

Go

Layout

Organizing a Go module - The Go Programming Language

Naming

styleguide
Style guides for Google-originated open-source projects

Common Mistakes

Go Wiki: Common Mistakes - The Go Programming Language

Baseline

Effective Go - The Go Programming Language
Go Wiki: Go Code Review Comments - The Go Programming Language

Style Guide

guide/style.md at master · uber-go/guide
The Uber Go Style Guide. Contribute to uber-go/guide development by creating an account on GitHub.

100 Go Mistakes

Common Go Mistakes - 100 Go Mistakes and How to Avoid Them
Summary of the mistakes in the 100 Go Mistakes book.

Clean code

GitHub - Pungyeon/clean-go-article: A reference for the Go community that covers the fundamentals of writing clean code and discusses concrete refactoring examples specific to Go.
A reference for the Go community that covers the fundamentals of writing clean code and discusses concrete refactoring examples specific to Go. - Pungyeon/clean-go-article