Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Add a go.mod file for basic Go modules support.#1

Merged
hjfreyer merged 1 commit intogoogle:masterfrom
creachadair:gomod
Feb 13, 2019
Merged

Add a go.mod file for basic Go modules support.#1
hjfreyer merged 1 commit intogoogle:masterfrom
creachadair:gomod

Conversation

@creachadair
Copy link
Copy Markdown
Contributor

In order to work well with Go modules, a package should have a go.mod file and semantic version tags on release versions. I have provided a rudimentary go.mod file here. Assuming you accept this change, and if you are willing to also git tag v0.0.1 master after it is merged, that would start the release history.

If the API of the package is considered stable, you could instead use v1.0.0, but at that point module users will expect breaking changes to increment the major version. I don't have a clear sense of how much this package is maintained, so v0 would be a safe default for now.

Also adds a conventional import comment, to document the expected import path.
@hjfreyer
Copy link
Copy Markdown
Contributor

I haven't actually worked with Go modules before, so having a co-worker take a look. Should get back later today!

@creachadair
Copy link
Copy Markdown
Contributor Author

I haven't actually worked with Go modules before, so having a co-worker take a look. Should get back later today!

Thanks! Please let me know if you or they have any questions. Since this package is self-contained, the configuration is trivial—the main thing to make it work well will be adding one or more release tags.

@hjfreyer hjfreyer merged commit 9a3d15e into google:master Feb 13, 2019
@hjfreyer
Copy link
Copy Markdown
Contributor

Tagged by creating a release: https://github.com/google/orderedcode/releases/tag/v0.0.1

Thanks for the change! Let me know if anything else needs changing.

@creachadair
Copy link
Copy Markdown
Contributor Author

Thanks! Everything looks sound from my side.

@creachadair creachadair deleted the gomod branch February 13, 2019 16:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants