What is this?
It's the Uber Go Style Guide — an open document describing the patterns and conventions Uber uses when writing Go code.
It's the Uber Go Style Guide — an open document describing the patterns and conventions Uber uses when writing Go code.So it's a document, not a library or a tool I can install?Right — there's nothing to install or run. It's a written guide you read and apply while coding in Go; the repo itself is just the guide text plus a Makefile and CI workflow for maintaining it.
Right — there's nothing to install or run. It's a written guide you read and apply while coding in Go; the repo itself is just the guide text plus a Makefile and CI workflow for maintaining it.How do I actually read it?No setup at all: the README links straight to the guide — open it in your browser and start reading.
No setup at all: the README links straight to the guide — open it in your browser and start reading.Is it the official Go style guide, or Uber's house rules?It's Uber's house style, not an official Go-team standard — it reflects what works for Uber's codebase, so other teams may reasonably adapt or deviate where their context differs.
It's Uber's house style, not an official Go-team standard — it reflects what works for Uber's codebase, so other teams may reasonably adapt or deviate where their context differs.Is it written only for Uber engineers?No — it's published openly under Apache-2.0 for anyone writing Go; seventeen community translations exist precisely because developers outside Uber rely on it.
No — it's published openly under Apache-2.0 for anyone writing Go; seventeen community translations exist precisely because developers outside Uber rely on it.Does it matter what OS or setup I have to use it?Not at all — it's a web document readable in any browser; nothing runs on your machine.
Not at all — it's a web document readable in any browser; nothing runs on your machine.Which languages can I read the guide in?Seventeen community translations are linked: Chinese (simplified and traditional), Korean, Japanese, Spanish, Thai, Portuguese and Brazilian Portuguese, Polish, Russian, French, Turkish, Ukrainian, Persian, Vietnamese, Arabic and Indonesian — each kept in its own repository.
Seventeen community translations are linked: Chinese (simplified and traditional), Korean, Japanese, Spanish, Thai, Portuguese and Brazilian Portuguese, Polish, Russian, French, Turkish, Ukrainian, Persian, Vietnamese, Arabic and Indonesian — each kept in its own repository.Is the guide Uber's own work or community-driven?The guide itself is maintained by Uber in this repo; the community's role is the translations — seventeen so far, each hosted separately and added via PRs.
The guide itself is maintained by Uber in this repo; the community's role is the translations — seventeen so far, each hosted separately and added via PRs.What are similar projects?laravel-best-practices, ruby-style-guide, awesome-guidelines, python-guide, project-layout, styleguide, clean-code-php, HowToBeAProgrammer
laravel-best-practices, ruby-style-guide, awesome-guidelines, python-guide, project-layout, styleguide, clean-code-php, HowToBeAProgrammerWhich topics is it in?clean-code, handbook, standards, makefile, style-guide, software-engineering, code-quality, best-practices, programming, multilingual, golang, reference
clean-code, handbook, standards, makefile, style-guide, software-engineering, code-quality, best-practices, programming, multilingual, golang, reference