diff --git a/CONTRIBUTING b/CONTRIBUTING index 4f3ac48..d7fdc8e 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -90,26 +90,44 @@ notice: * USE OR OTHER DEALINGS IN THE SOFTWARE. */ -When writing code, make sure lines never exceed 80 characters in width when -using four-character-wide indentation steps. +Make sure lines never exceed 80 columns in width when using four-character +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 -print usage information when any erroneous option is specified. Follow the -NetBSD style guide for usage text output format [1]. +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 +style guide for the usage text’s output format [1]. -If committing a new source file for a utility, format the commit message like -this: +[1] -$ git commit -m 'tool(1): ' +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: -$ git commit -m 'library(1): ' +$ 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: -$ git commit -m 'README: clarification' -$ git commit -m 'tests: posix: fixed bug #47' -$ git commit -m 'docs: tool(1): added author information' +$ git commit -m 'README: clarify' +$ git commit -m 'tests/posix: fix bug #47' -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