From 0d445c71f48d2efee0a02f1c900f782f11ad355b Mon Sep 17 00:00:00 2001 From: emma Date: Sun, 18 Feb 2024 15:09:09 -0700 Subject: [PATCH] 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