From 31513796b0057e4d7e623a22e664b3557bbe54a3 Mon Sep 17 00:00:00 2001 From: Stefan Majewsky Date: Sat, 2 May 2026 00:16:01 +0200 Subject: README: adjust contribution notes, acknowledge the non-ORM-ness --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0bc2e9e..d49165d 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ Please refer to the [package documentation](https://pkg.go.dev/go.xyrillian.de/o ## How to contribute -The primary repository at is only writable by the maintainer. -To contribute, you may 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 have a GitHub account, you can submit issues and pull requests at the mirror repository . +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 , 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 . ## Design goals and priorities @@ -39,3 +40,5 @@ Explicit non-goals include: Another thing that the author of this library does not believe to be worthwhile in an ORM library. In real-world applications, you will need to manage the schema using versioned schema migrations. Schemas generated by ORM libraries from type declarations cannot really offer this, especially once you get into stored functions, triggers and so on. + +The author realizes that this means that Oblast is technically only an OM library, not an ORM library. Sometimes, optimization means getting rid of on of th lttrs. -- cgit v1.2.3