From 452a1295e6d2231323d9a6ef267663ca4e8b268b Mon Sep 17 00:00:00 2001 From: emma Date: Wed, 7 Feb 2024 21:54:46 -0700 Subject: [PATCH 1/4] CONTRIBUTING: updated and added copyright info --- CONTRIBUTING | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 4f3ac48..cadba82 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -90,8 +90,9 @@ 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 characters in width when using +four-character-wide indentation steps. This helps contributors who do not have +text wrapping in their text editors. 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 @@ -100,16 +101,31 @@ NetBSD style guide for usage text output format [1]. If committing a new source file for a utility, format the commit message like this: -$ git commit -m 'tool(1): ' +$ git commit -m 'tool(1): added feature x' If committing a new library or header file: -$ git commit -m 'library(1): ' +$ git commit -m 'library(3): fixed overflow' +$ git commit -m 'header.h(3): added header.h(3)' + +If committing a new manual page: + +$ git commit -m 'tool.1: added 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 'tests/posix: fixed bug #47' -etc. +For multiple of these: + +$ git commit -m 'Makefile, tool(1): added tool(1)' +$ git commit -m 'tool(1): added tool(1); \ + library(3), library.3: added library(3)' + + +[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 +copy of this license, visit From d45e3410f8261d831e020e0dbf78e405f8397f3e Mon Sep 17 00:00:00 2001 From: emma Date: Wed, 7 Feb 2024 22:03:08 -0700 Subject: [PATCH 2/4] CONTRIBUTING: fixed some small issues --- CONTRIBUTING | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index cadba82..ee4e1ec 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -90,16 +90,16 @@ notice: * USE OR OTHER DEALINGS IN THE SOFTWARE. */ -Make sure lines never exceed 80 characters in width when using -four-character-wide indentation steps. This helps contributors who do not have -text wrapping in their text editors. +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 +wrapping in their text editors or terminals. -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: +If committing a new source file, format the commit message following these +guidelines: $ 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: -$ git commit -m 'README: clarification' +$ git commit -m 'README: clarified' $ git commit -m 'tests/posix: fixed bug #47' For multiple of these: @@ -122,9 +122,11 @@ For multiple of these: $ git commit -m 'Makefile, tool(1): added tool(1)' $ git commit -m 'tool(1): added tool(1); \ 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] -- This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a From 0d445c71f48d2efee0a02f1c900f782f11ad355b Mon Sep 17 00:00:00 2001 From: emma Date: Sun, 18 Feb 2024 15:09:09 -0700 Subject: [PATCH 3/4] CONTRIBUTING: fixed wording and updated --- CONTRIBUTING | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index ee4e1ec..34cc31f 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -65,7 +65,7 @@ notice: * This file incorporates work covered by the following copyright and permission * notice: * - * MIT License + * MIT Licenseutils * * Copyright (c) * @@ -91,42 +91,43 @@ notice: */ 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 -wrapping in their text editors or terminals. +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, 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]. +[1] + If committing a new source file, format the commit message following these 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: -$ git commit -m 'library(3): fixed overflow' -$ git commit -m 'header.h(3): added header.h(3)' +$ 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: added author details' +$ git commit -m 'tool.1: add author details' If modifying some other file or directory: -$ git commit -m 'README: clarified' -$ git commit -m 'tests/posix: fixed bug #47' +$ git commit -m 'README: clarify' +$ git commit -m 'tests/posix: fix bug #47' For multiple of these: -$ git commit -m 'Makefile, tool(1): added tool(1)' -$ git commit -m 'tool(1): added tool(1); \ - library(3), library.3: added library(3)' -$ git commit -m 'tool(1): fixed #42 & added feature x' +$ 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 past tense. - -[1] +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 From 06fc46198504a0812c3c2e82bc1efb973e96ff5b Mon Sep 17 00:00:00 2001 From: emma Date: Fri, 23 Feb 2024 23:19:28 -0700 Subject: [PATCH 4/4] CONTRIBUTING: fixed random "utils" --- CONTRIBUTING | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 34cc31f..d7fdc8e 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -65,7 +65,7 @@ notice: * This file incorporates work covered by the following copyright and permission * notice: * - * MIT Licenseutils + * MIT License * * Copyright (c) * @@ -123,8 +123,7 @@ $ git commit -m 'tests/posix: fix bug #47' 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): 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.