~eliasnaur/gio/contributing

This commit

commit 4089b6f8c7cda3a2f86f770a15b15c1af9c643d8
Author: Elias Naur <mail@eliasnaur.com>
Date:   2019-08-14T08:57:09+00:00

install.md: add note about -H windowsgui for avoiding the Windows console

Signed-off-by: Elias Naur <mail@eliasnaur.com>
Clone this wiki
https://git.sr.ht/~eliasnaur/gio (read-only) git@git.sr.ht:~eliasnaur/gio (read/write)

Commit messages follow the Go project style: 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. 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 git-send-email.io for a thorough setup guide.

With git send-email configured, you can clone the project and set it up for submitting your changes:

$ git clone https://git.sr.ht/~eliasnaur/gio
$ cd gio
$ git config sendemail.to '~eliasnaur/gio@lists.sr.ht'
$ git config sendemail.annotate yes

Configure your name and email address if you have not done so already:

$ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"

Contributors must agree to the developer certificate of origin, to ensure their work is compatible with the MIT and the UNLICENSE. Sign your commits with Signed-off-by statements to show your agreement. The git commit --signoff (or -s) command signs a commit with your name and email address.

Whenever you want to submit your work for review, use git send-email with the base revision of your changes. For example, to submit the most recent commit use

$ git send-email HEAD^