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

Merge branch 'contributing-changes'

Browse Source
This commit is contained in:
Emma Tebibyte 2024-02-23 23:20:16 -07:00
commit c97201fca9
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 31 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
CONTRIBUTING
View File

@ -90,26 +90,44 @@ notice:
* USE OR OTHER DEALINGS IN THE SOFTWARE. * USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
When writing code, make sure lines never exceed 80 characters in width when Make sure lines never exceed 80 columns in width when using four-character
using four-character-wide indentation steps. indentation steps. This helps contributors with smaller screens, those using
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, 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 [1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
this:
$ git commit -m 'tool(1): <information>' If committing a new source file, format the commit message following these
guidelines:
$ 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(1): <information>' $ git commit -m 'library(3): fix overflow'
$ git commit -m 'header.h(3): add header.h(3)'
If committing a new manual page:
$ 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: clarification' $ git commit -m 'README: clarify'
$ git commit -m 'tests: posix: fixed bug #47' $ git commit -m 'tests/posix: fix bug #47'
$ git commit -m 'docs: tool(1): added author information'
etc. For multiple of these:
$ git commit -m 'Makefile, tool(1): add tool(1)'
$ git commit -m 'tool(1): add tool(1); library(3), library.3: add library(3)'
$ git commit -m 'tool(1): fix #42 & add feature x'
Commit messages should be written in the present tense.
--
This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a
copy of this license, visit <http://creativecommons.org/licenses/by-sa/4.0/>