docs: Go patterns vs official guidelines divergence analysis
This commit is contained in:
@@ -0,0 +1,18 @@
|
||||
# Patterns vs Official Guidelines
|
||||
|
||||
Divergence analyses comparing our extracted-from-source patterns against official coding guidelines.
|
||||
|
||||
## Reports
|
||||
|
||||
| Ecosystem | Our Patterns | Official Guidelines | Report |
|
||||
|-----------|-------------|--------------------|---------|
|
||||
| Go | [rodin/go-patterns](https://gitea.weiker.me/rodin/go-patterns) | Effective Go, Code Review Comments, Google Style | [go/](go/) |
|
||||
| Elixir | [rodin/elixir-patterns](https://gitea.weiker.me/rodin/elixir-patterns) | CONTRIBUTING.md, Style Guide, HexDocs | [elixir/](elixir/) |
|
||||
|
||||
## Philosophy
|
||||
|
||||
Official guides tell you what to do. Source patterns show what mature code actually does.
|
||||
When they diverge, neither is wrong — they serve different audiences and optimize for
|
||||
different things.
|
||||
|
||||
This repo documents where they agree, where they differ, and why.
|
||||
Reference in New Issue
Block a user