From f981b3aa3b6f360785e21ab66dc0ddc7fa0f5041 Mon Sep 17 00:00:00 2001 From: cdez Date: Thu, 29 Sep 2022 09:33:49 -0700 Subject: [PATCH] Update README with Cdez's Standards +- README for Cdez's Standards for Committing Signed-off-by: cdez --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index fac8fd3..f10d84a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # INF110-Projects A place that I store all the INF110 work that I will do over the coming semester. + +## Cdez's Standards for Committing +### Standard 1: +Use "++" in the extended description to show what was added, either generally, or specifically. +Use "+-" in the extended description to show what was modified/changed, either generally, or specifically. +Use "--" in the extended description to show what was removed, either generally, or specifically. +### Standard 2: +The description will have the biggest changes listed, in the order of biggest to smallest differences. +### Standard 3: +If committing to main, make sure to have all the above standards in order before committing. +### Standard 4: +Pull Requests: +#### Standard 4.1: +Create a new working branch from main. (Or you may use the 'Create a new branch GitWeb function.') +#### Standard 4.2: +Call the branch the biggest change of the branch, using Standard 1 in it's name with the biggest change/addition/removal. +#### Standard 4.3: +When done with the branch, merge into main, and make sure to have very detailed descriptions. \ No newline at end of file