forked from bonsai/harakit
CONTRIBUTING: fixed some small issues
This commit is contained in:
parent
452a1295e6
commit
d45e3410f8
22
CONTRIBUTING
22
CONTRIBUTING
@ -90,16 +90,16 @@ notice:
|
|||||||
* USE OR OTHER DEALINGS IN THE SOFTWARE.
|
* USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
Make sure lines never exceed 80 characters in width when using
|
Make sure lines never exceed 80 columns in width when using four-character
|
||||||
four-character-wide indentation steps. This helps contributors who do not have
|
indentation steps. This helps contributors who do not have access to text
|
||||||
text wrapping in their text editors.
|
wrapping in their text editors or terminals.
|
||||||
|
|
||||||
For usage text and help messages, please do not implement a -h option. Just
|
For usage text and help messages, do not implement a -h option. Instead, print
|
||||||
print usage information when any erroneous option is specified. Follow the
|
usage information when any erroneous option is specified. Follow the NetBSD
|
||||||
NetBSD style guide for usage text output format [1].
|
style guide for the usage text’s output format [1].
|
||||||
|
|
||||||
If committing a new source file for a utility, format the commit message like
|
If committing a new source file, format the commit message following these
|
||||||
this:
|
guidelines:
|
||||||
|
|
||||||
$ git commit -m 'tool(1): added feature x'
|
$ git commit -m 'tool(1): added feature x'
|
||||||
|
|
||||||
@ -114,7 +114,7 @@ $ git commit -m 'tool.1: added author details'
|
|||||||
|
|
||||||
If modifying some other file or directory:
|
If modifying some other file or directory:
|
||||||
|
|
||||||
$ git commit -m 'README: clarification'
|
$ git commit -m 'README: clarified'
|
||||||
$ git commit -m 'tests/posix: fixed bug #47'
|
$ git commit -m 'tests/posix: fixed bug #47'
|
||||||
|
|
||||||
For multiple of these:
|
For multiple of these:
|
||||||
@ -122,9 +122,11 @@ For multiple of these:
|
|||||||
$ git commit -m 'Makefile, tool(1): added tool(1)'
|
$ git commit -m 'Makefile, tool(1): added tool(1)'
|
||||||
$ git commit -m 'tool(1): added tool(1); \
|
$ git commit -m 'tool(1): added tool(1); \
|
||||||
library(3), library.3: added library(3)'
|
library(3), library.3: added library(3)'
|
||||||
|
$ git commit -m 'tool(1): fixed #42 & added feature x'
|
||||||
|
|
||||||
|
Commit messages should be written in the past tense.
|
||||||
|
|
||||||
[1] http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style
|
[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
|
||||||
|
|
||||||
--
|
--
|
||||||
This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a
|
This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a
|
||||||
|
Loading…
Reference in New Issue
Block a user