joejulian/gio
1
0
Fork 1
mirror of https://git.sr.ht/~eliasnaur/gio synced 2026-07-01 07:35:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

README.md: add note about commit message style

Browse Source 
And move the issues section above the heavy contribution section
while we're here.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
This commit is contained in:
Elias Naur
2019-04-03 12:19:16 +02:00
parent 2a99e1c955
commit fca780972a
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -5
View File
@@ -93,6 +93,11 @@ To run the demo on an iOS device, use the sample Xcode project:
You need to provide a valid bundle identifier and set up code signing in Xcode to run the demo
on a device. If you're using Go 1.12 or older, you also need to disable bitcode.
## Issues
File bugs and TODOs in the [issue tracker](https://todo.sr.ht/~eliasnaur/gio) or send them to
[the mailing list](mailto:~eliasnaur/gio-dev@lists.sr.ht).
## License
Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
@@ -101,6 +106,13 @@ Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
Discussion and patches: [~eliasnaur/gio-dev@lists.sr.ht](mailto:~eliasnaur/gio-dev@lists.sr.ht).
Commit messages follow [the Go project style](https://golang.org/doc/contribute.html#commit_messages):
the first line is prefixed with the package and a short summary. The rest of the message provides context
for the change and what it does. See
[an example](https://git.sr.ht/~eliasnaur/gio/commit/abb9d291e954f3b80384046d7d4487e1ead6bd6a).
Add `Fixes ~eliasnaur/gio#nnn` or `Updates ~eliasnaur/gio#nnn` if the change fixes or updates an existing
issue.
The `git send-email` command is a convenient way to send patches to the mailing list; see
[instructions](https://man.sr.ht/git.sr.ht/send-email.md) for setting up git to use your email service.
@@ -120,8 +132,3 @@ Whenever you want to submit your work for review, use `git send-email` with the
changes. For example, to submit the most recent commit use
$ git send-email HEAD^
## Issues
File bugs and TODOs in the [issue tracker](https://todo.sr.ht/~eliasnaur/gio) or send them to
[the mailing list](mailto:~eliasnaur/gio-dev@lists.sr.ht).