aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2025-02-12 16:46:20 +0100
committerStefan Majewsky <majewsky@gmx.net>2025-02-12 16:52:35 +0100
commit23862346411fb921e1a45f25011c3db601f8591d (patch)
treee611d45959a8ad311e9b6c91e4ef123a3fbcf8e9
parente739523ac1f926007fcfd8d82e5559df37cc6c6b (diff)
downloadgo-gg-ede18b896f4a7ba66214942c5fa9c292f21fd233.tar.gz
v1.0.0v1.0.0
-rw-r--r--CHANGELOG.md4
-rw-r--r--CONTRIBUTING.md7
-rw-r--r--README.md8
-rw-r--r--go.mod2
4 files changed, 16 insertions, 5 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..a201d67
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,4 @@
+# v1.0.0 (2025-02-12)
+
+Initial release. The Go version requirement is 1.24.0 because `type Option`
+depends on support for `omitzero` in encoding/json for correct marshaling.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..21fa275
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+# Notes for contributors
+
+This repository accepts contributions as follows:
+
+- For new methods and functions, feel free to submit a PR right away.
+- For entirely new types, or when adding library dependencies, please open an issue first to discuss the design.
+- Generally, we dislike library dependencies in this house because every dependency means extra work from Dependabot.
diff --git a/README.md b/README.md
index eb401cc..b5c5010 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
# gg (Generic Generics)
A Go library for the generic types that should be in the standard library, but aren't.
-Currently, this includes [Option](./option/), but `Result` or `Either` could also be added once there is a compelling usecase for myself.
+Currently, this includes [Option](./option/).
+I may additional types like `Result`, `Either` or `Pair` if:
-## No release?
-
-This type relies on behavior that is being introduced in Go 1.24. The 1.0 release will be made as soon as Go 1.24 releases.
+- there is a compelling usecase for myself, and
+- an API can be built that is ergonomic in practice (this is the biggest reason why `Result` might never happen).
diff --git a/go.mod b/go.mod
index c394546..c5890e3 100644
--- a/go.mod
+++ b/go.mod
@@ -1,3 +1,3 @@
module github.com/majewsky/gg
-go 1.23
+go 1.24