Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go typographic conventions #8

Open
thomas-fossati opened this issue Dec 9, 2022 · 0 comments
Open

go typographic conventions #8

thomas-fossati opened this issue Dec 9, 2022 · 0 comments

Comments

@thomas-fossati
Copy link

thomas-fossati commented Dec 9, 2022

https://go.dev/doc/effective_go provides a number of conventions that tend to be used (and expected by) the Go community. It looks like this very nice and useful package may use some of that collected wisdom to make itself even more ergonomic and palatable to the Go crowd :-)

For example:

  • The package name is excessively long. Suggestion: change it to go-nitro, or nitro-attestation
  • variable, function and constant names should be camel- rather than snake-case
  • source file naming: lib.go is not where a Gopher would expect to find the package implementation. It's more a Rustacean convention I guess :-)
  • comments (in particular go doc stuff) should be checked for fitness.

A lot of this tedious stuff is normally flagged by the linter. So, adding a linting step to the CI pipeline usually helps a lot with keeping consistency.

I'd be happy to help with the "apply conventions" pass if you want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant