Bahlo's Style Guide #44

New Issue

jeff · 2021-06-20T20:40:59Z

jeff commented

2021-06-20 20:40:59 +00:00

https://github.com/bahlo/go-styleguide

Add context to errors. After reading the logs, this will significantly cut down debugging time.

Use structured logging.

Avoid package-level variables. If you do use one, put it at the top of the file.

Keep the happy path left.

Avoid mocks.

Avoid side-effects and favor pure funcs.

Avoid naked returns. Use named return variables for documentation only.

Put main as the first func.

Avoid generic package names such as "helper" and "util".

Avoid using the keyword "new".

https://github.com/bahlo/go-styleguide Add context to errors. After reading the logs, this will significantly cut down debugging time. Use structured logging. Avoid package-level variables. If you do use one, put it at the top of the file. Keep the happy path left. Avoid mocks. Avoid side-effects and favor pure funcs. Avoid naked returns. Use named return variables for documentation only. Put main as the first func. Avoid generic package names such as "helper" and "util". Avoid using the keyword "new".

Sign in to join this conversation.