commit bf6b0ca8870d05e1193797e86fa34dd9ef779fb4 parent 57fae4fd068fd5a29498f1c3e81c94772b6d48fa Author: Oliver Lowe <o@olowe.co> Date: Wed, 17 Jul 2024 21:55:45 +1000 add example "ideal" commit message not ideal, I dunno. But an example Diffstat:
| M | README.md | | | 12 | +++++++++--- |
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -1,4 +1,4 @@ -[](https://pkg.go.dev/github.com/untangledco/streaming) +\[](https://pkg.go.dev/github.com/untangledco/streaming) This repository contains packages for developing media streaming systems in Go. Watch it being developed live! @@ -42,13 +42,19 @@ See [git-send-email.io](https://git-send-email.io) if you're unfamiliar with the git config sendemail.to '~otl/untangledco@lists.sr.ht' -We also accept changes via [pull requests](https://github.com/untangledco/streaming/pulls). +We also accept changes via [pull request](https://github.com/untangledco/streaming/pulls). ### Commit messages -Commit messages follow the same format used by the [Go] project (among others). +Commit messages follow the same format used by the [Go] project (and others). The commit subject starts with the affected package name then a brief description of the change. The body may contain an explanation of the change and why it was made. +For example: + + sdp: store attributes as key-value pairs + + This matches what the spec allows, and lets users not worry about + encoding. [Go]: https://go.dev/doc/contribute#commit_messages