aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2026-07-30 20:23:43 +0200
committerStefan Majewsky <majewsky@gmx.net>2026-07-30 20:23:43 +0200
commit584bdd9d0c0a0e066df69cc5f11de352166d7271 (patch)
treea3527222832412e5897c80319e6718c55a8b9e55
parent1186412d28857b9bfa14e7e3106ecd845e71fe71 (diff)
downloadgo-gg-pgx-584bdd9d0c0a0e066df69cc5f11de352166d7271.tar.gz
extend README with contributing notes
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3bccaad..dfe0e09 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,16 @@ SPDX-License-Identifier: Apache-2.0
# gg-pgx
Integration for using [gg/gsql](https://pkg.go.dev/go.xyrillian.de/gg/gsql) (and libraries based on it, such as [Oblast](https://pkg.go.dev/go.xyrillian.de/oblast)) with the PostgreSQL driver library [pgx](https://github.com/jackc/pgx).
+
+## How to contribute
+
+This repository accepts contributions as follows:
+
+- For bugfixes or dependency updates, feel free to submit a PR right away.
+- For entirely new types, or when adding library dependencies, please send a mail or open a GitHub 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.
+
+To contribute to the primary repository at <https://git.xyrillian.de/go-gg-pgx>, 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-pgx>.