/go-code-convention

@unknwon's opinionated and paranoid Go code convention.

The UnlicenseUnlicense

Go Code Convention

This is a 100% opinionated and paranoid code convention for the Go Programming Language by @unknwon. It may or may not be compatible with Go Code Review Comments, or any other guidelines out there. That's fine, that is neither mine nor your problem.

Be sure to always remember, "尽信书不如无书".

For non-Chinese readers, what does 尽信书不如无书 mean?


Ready? OK, pick one you like:

Roadmap for current version

  • Overhaul exsiting content for en-US
  • Add more pages about:
    • Linting
    • Database layer construction and testing
    • Error wrapping
    • Dependency injection
    • TBD
  • Re-translated everything from en-US to zh-CN

Notes about v1

The v1 was originally drafted back in 2015, and majority of the content hasn't been updated since. As of 2021, after another 6 years working with Go, some of aspects already feel outdated for me, especially I've learned more practices by working with amazing people. I would love to have these practices documented so I can reference back.

License

This project is under the Unlicense License. See the LICENSE file for the full license text.