Skip to content

Commit

Permalink
docs: v1.0 touch-up
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Bray <[email protected]>
  • Loading branch information
timbray committed Jan 22, 2023
1 parent c402b54 commit dbb2212
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit dbb2212

Please sign in to comment.