aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2026-05-03 20:16:14 +0200
committerStefan Majewsky <majewsky@gmx.net>2026-05-03 20:16:14 +0200
commit80e08e6aee59ef32355fe5a376f295f1fd7dec1c (patch)
treeb49c2f974a9898caa3dd9cb094101a1b236c0e32 /README.md
parent9fd5ae1214c3f4af53dfa5c45adee68769981b18 (diff)
downloadgo-gg-80e08e6aee59ef32355fe5a376f295f1fd7dec1c.tar.gz
change module path to go.xyrillian.de/gg
Also, some other small adjustments for the documentation to make it fit with the overall vibe of the new home.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 90ae517..0a07bec 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ SPDX-License-Identifier: Apache-2.0
# gg (Generic Generics)
-My personal extension of the standard library, mostly containing foundational generic types.
+My personal extension of the standard library, with foundational generic types and `net/http` addons.
## List of packages
@@ -21,3 +21,16 @@ I may add additional types (e.g. `Result`, `Either` or `Pair`) if:
- there is a compelling usecase for myself, and
- I find an API that is ergonomic in practice (this is the biggest reason why `Result` might never happen).
+
+## How to contribute
+
+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 managing dependency upgrades.
+
+Before sending a patch, please ensure that `make check` does not report any problems, and run `make benchmark` to check the performance impact of your changes.
+
+To contribute to the primary repository at <https://git.xyrillian.de/go-gg>, please use `git format-patch` in the usual manner and send patches to the maintainer's mail address (which can be found in the copyright notice headers on each file).
+Alternatively, if you are still using GitHub, you can submit issues and pull requests at the mirror repository <https://github.com/majewsky/gg>.