From 49245844a7fd21ac0c9c922933d4364fe3a8ed94 Mon Sep 17 00:00:00 2001 From: Adam Date: Thu, 8 Feb 2024 15:14:23 -0600 Subject: [PATCH] docs: fix grammar and spelling --- CONTRIBUTING.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cf0bb4..2fe7c9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,20 @@ # Contributing - [Code Of Conduct](#code-of-conduct) + - [Principles](#principles) + - [Violations](#violations) + - [Feedback](#feedback) - [Submission Guidelines](#submission-guidelines) + - [Submitting An Issue](#submitting-an-issue) + - [Commenting On A Issue](#commenting-on-a-issue) + - [Issue Closure](#issue-closure) + - [Issue Re-Opening](#issue-re-opening) - [Commit Message Guidelines](#commit-message-guidelines) + - [Commit Message Format](#commit-message-format) + - [Type](#type) + - [Subject](#subject) + - [Body](#body) + - [Footer](#footer) ## Code Of Conduct @@ -31,7 +43,7 @@ relations and/or blocking accounts. ### Feedback -If you are subject to or witness of unacceptable behavior or have any other +If you are subject to or witness of unacceptable behaviour or have any other concerns, please contact us. ## Submission Guidelines @@ -63,7 +75,7 @@ Valid reasons for closing an issue: - A reference to the duplicate must be added before closure. - Lacks enough information to re-produce. - No longer relevant. -- Off topic. +- Off-topic. - Resolved. - Multiple issues within the submission. - Will not be resolved. @@ -122,7 +134,7 @@ Use one of the following applicable type. - revert - When commit reverts a previous commit. - style - - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.). + - Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.). - test - Adding or modifying tests. @@ -137,7 +149,7 @@ Use one of the following applicable type. - Use the imperative, present tense: "change" not "changed" nor "changes". - Include the motivation for the change and contrast this with previous -behavior. +behaviour. - If commit type is **revert**, in the body state `This reverts commit `. The `` is the hash value of the commit being reverted.