From dbb2212e7b5c3ffbfd6732a1a3888744e4042d02 Mon Sep 17 00:00:00 2001 From: Tim Bray Date: Sat, 21 Jan 2023 16:33:45 -0800 Subject: [PATCH] docs: v1.0 touch-up Signed-off-by: Tim Bray --- CONTRIBUTING.md | 7 +++++++ README.md | 2 ++ 2 files changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82d1b63..67d9d4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,13 @@ Currently the following prefixes are used: If your contribution falls into multiple categories, e.g. `api` and `pat` it is recommended to break up your commits using distinct prefixes. +### Signing commits + +Commits should be signed (not just the `-s` “signd off on”) with +any of the [styles GitHub supports](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). +Note that you use `git config` to arrange that your commits are +automatically signed with the right key. + ### Running Tests In any repo subdirectory, `go test` runs unit tests diff --git a/README.md b/README.md index bd3c77a..8e0f626 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ and then query data objects called **Events** to discover which of the Patterns match the fields in the Event. +Quamina has no run-time dependencies beyond built-in Go libraries. + Quamina [welcomes contributions](CONTRIBUTING.md). ### Status