From 26620324c1ce4cc739745115214f827f838a27b3 Mon Sep 17 00:00:00 2001 From: "coded (Samuel Shuert)" Date: Mon, 6 May 2024 20:10:50 +0000 Subject: [PATCH] docs: update contributing/formatting/projects --- contributing/formatting/projects.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/contributing/formatting/projects.md b/contributing/formatting/projects.md index 754acc4..18fd2cd 100644 --- a/contributing/formatting/projects.md +++ b/contributing/formatting/projects.md @@ -2,7 +2,7 @@ title: Project Standards description: published: true -date: 2024-05-06T20:03:03.088Z +date: 2024-05-06T20:10:49.577Z tags: editor: markdown dateCreated: 2024-05-05T21:22:30.441Z @@ -23,4 +23,8 @@ All projects should provide: # Commit Messages - First line of the commit message should be a short (<50 chars) description of the purpose of the commit - First word should be one of: `feat:` for feature, `fix:` for bugfixes, or `break:` for breaking changes -- \ No newline at end of file +- First line and main message should have 1 blank newline in between them for ease of reading +- Main messages + - **Features** should have a reason to include the feature, as well as an example of the feature in use (if applicable) + - **Fixes** should have what the original bug was, as well as a short summary of the steps that were required to fix it + - **Breaking Changes** should have what it breaks, how it breaks it, and a short transition guide