https://github.com/unknwon/go-code-convention

@unknwon's opinionated and paranoid Go code convention.
https://github.com/unknwon/go-code-convention

code-conventions coding-guidelines go

Last synced: 11 days ago
JSON representation

@unknwon's opinionated and paranoid Go code convention.

• Host: GitHub
• URL: https://github.com/unknwon/go-code-convention
• Owner: unknwon
• License: unlicense
• Created: 2014-05-16T15:05:20.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2021-05-19T07:35:33.000Z (about 3 years ago)
• Last Synced: 2024-05-02T01:08:11.920Z (about 2 months ago)
• Topics: code-conventions, coding-guidelines, go
• Homepage:
• Size: 68.4 KB
• Stars: 344
• Watchers: 18
• Forks: 74
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• go-awesome - Go Code Convention
• go-awesome - Go Code Convention
• go-awesome - Go code convention

README

        
# Go Code Convention

This is a 100% opinionated and paranoid code convention for the Go Programming Language by [@unknwon](https://github.com/unknwon). It may or may not be compatible with [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments), or any other guidelines out there. That's fine, that is neither mine nor your problem.

![](https://imgs.xkcd.com/comics/standards.png)

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

For non-Chinese readers, [what does 尽信书不如无书 mean?](https://chinese.stackexchange.com/a/26717)




Ready? OK, pick one you like:

- [English](en-US.md)

- [简体中文](zh-CN/README.md) _Stay tuned!_

## Roadmap for current version

- [x] Overhaul exsiting content for en-US

- [ ] Add more pages about:

  - [x] 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](https://github.com/unknwon/go-code-convention/tree/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](LICENSE) file for the full license text.