trinity/overgrown
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CONTRIBUTING: fixed wording and updated

Browse Source
This commit is contained in:
Emma Tebibyte 2024-02-18 15:09:09 -07:00
parent d45e3410f8
commit 0d445c71f4
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING
View File

@ -65,7 +65,7 @@ notice:
* This file incorporates work covered by the following copyright and permission * This file incorporates work covered by the following copyright and permission
* notice: * notice:
* *
* MIT License * MIT Licenseutils
* *
* Copyright (c) <year> <copyright holders> * Copyright (c) <year> <copyright holders>
* *
@ -91,42 +91,43 @@ notice:
*/ */
Make sure lines never exceed 80 columns in width when using four-character Make sure lines never exceed 80 columns in width when using four-character
indentation steps. This helps contributors who do not have access to text indentation steps. This helps contributors with smaller screens, those using
wrapping in their text editors or terminals. side-by-side editor windows or panes, and those who have no text wrapping in
their editor or terminal.
For usage text and help messages, do not implement a -h option. Instead, print For usage text and help messages, do not implement a -h option. Instead, print
usage information when any erroneous option is specified. Follow the NetBSD usage information when any erroneous option is specified. Follow the NetBSD
style guide for the usage text’s output format [1]. style guide for the usage text’s output format [1].
[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
If committing a new source file, format the commit message following these If committing a new source file, format the commit message following these
guidelines: guidelines:
$ git commit -m 'tool(1): added feature x' $ git commit -m 'tool(1): add feature x'
If committing a new library or header file: If committing a new library or header file:
$ git commit -m 'library(3): fixed overflow' $ git commit -m 'library(3): fix overflow'
$ git commit -m 'header.h(3): added header.h(3)' $ git commit -m 'header.h(3): add header.h(3)'
If committing a new manual page: If committing a new manual page:
$ git commit -m 'tool.1: added author details' $ git commit -m 'tool.1: add author details'
If modifying some other file or directory: If modifying some other file or directory:
$ git commit -m 'README: clarified' $ git commit -m 'README: clarify'
$ git commit -m 'tests/posix: fixed bug #47' $ git commit -m 'tests/posix: fix bug #47'
For multiple of these: For multiple of these:
$ git commit -m 'Makefile, tool(1): added tool(1)' $ git commit -m 'Makefile, tool(1): add tool(1)'
$ git commit -m 'tool(1): added tool(1); \ $ git commit -m 'tool(1): add tool(1); \
library(3), library.3: added library(3)' library(3), library.3: add library(3)'
$ git commit -m 'tool(1): fixed #42 & added feature x' $ git commit -m 'tool(1): fix #42 & add feature x'
Commit messages should be written in the past tense. Commit messages should be written in the present tense.
[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