Need help with go-best-practices?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

codeship
507 Stars 50 Forks 23 Commits 6 Opened issues

Description

Codeship Golang Best Practices

Services available

!
?

Need anything else?

Contributors list

Codeship Golang Best Practices

Motivation

To achieve consistency and simplicity throughout our Go codebases. This is to aid in readability, maintainability and efficiency when onboarding and during code review.

This document is built upon and inspired by a number of articles and talks given over the past few years by the Go community. These practices are not unique, everything is borrowed.

Contents

Resources

Extra Goodies

We run markdown-spellcheck in CI on all contributions. Failure to amend such errors will result in changes being rejected.

make spellcheck
to get quick validation

make fix-spelling
to use
mdspell
interactive correction functionality and to maintain the
.spelling
file.

see output and see mdspell for details on how to maintain the

.spelling
file.

Contributing

Everyone interacting in the project and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Code of Conduct.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.