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
Approach
How to Do Thoughtful Code Reviews
Learn thoughtful code reviews with tips on communication, empathy, automation, and setting standards for improved code quality and team collaboration
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.
Sara VerdiGraphite software engineer
Commits
Conventional Commits Cheatsheet
Conventional Commits Cheatsheet. GitHub Gist: instantly share code, notes, and snippets.
262588213843476
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.
262588213843476Go
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
GitHub - evrone/go-clean-template: Clean Architecture template for Golang services
Clean Architecture template for Golang services. Contribute to evrone/go-clean-template development by creating an account on GitHub.
evroneNaming
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.
uber-go100 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
PungyeonAPI
API design guide | Cloud API Design Guide | Google Cloud
A set of guidelines for designing APIs that are consistent with Google AIPs.
