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

Convert to Go Modules and standardize package structure #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JeremyLoy
Copy link

  • Go modules are now production ready
  • This lowers the overhead of adding new contributors to the project, as they do not have to setup or work in GOPATH
  • This change also makes builds deterministic, as go.mod + go.sum pin package versions
  • a few package imports had to change slightly. In addition I took a pass of all files using gofmt
  • added a .gitignore
  • also updated the README.md
    • numbered lists can all just be 1. but still render in an ascending list. This prevents the need to widely refactor to maintain ordering
    • updated the instructions on running and testing

* Go modules are now production ready
  * https://golang.org/doc/go1.14#introduction
* This lowers the overhead of adding new contributors to the project, as they do not have to setup or work in GOPATH
* This change also makes builds deterministic, as `go.mod` + `go.sum` pin package versions
* a few package imports had to change slightly. In addition I took a pass of all files using `gofmt`
* added a `.gitignore`
* also updated the README.md
  * numbered lists can all just be `1.` but still render in an ascending list. This prevents the need to widely refactor to maintain ordering
  * updated the instructions on running and testing
@JeremyLoy
Copy link
Author

The reason for the 1k diff (apologies btw) is because the project wasn't formatted via go fmt. No actual changes were made other than the few imports like I mentioned above.

It's easy to run and it's built in.

go fmt ./...

Its the de facto way Go code is formatted both inside and outside of Google.

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

Successfully merging this pull request may close these issues.

1 participant