WindKube

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

PR Title & Description

Best practices for writing clear pull request titles and descriptions
This guide shows you how to craft pull request titles and descriptions and shares best practices, examples, and tips for maintaining clarity and organization.
Graphite.devSara VerdiGraphite software engineer

Commits

Conventional Commits Cheatsheet
Conventional Commits Cheatsheet. GitHub Gist: instantly share code, notes, and snippets.
Gist262588213843476

Standards

The Standard of Code Review
Google’s Engineering Practices documentation
eng-practices

Documentation

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

Go

Design Patterns

Design Patterns in Go
The catalog of annotated code examples of all design patterns, written in Go.

Layout

Organizing a Go module - The Go Programming Language
Google logo

Naming

styleguide
Style guides for Google-originated open-source projects
styleguide

Common Mistakes

Go Wiki: Common Mistakes - The Go Programming Language
Google logo

Baseline

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

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.
GitHububer-go

100 Go Mistakes

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

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
GitHubPungyeon