From 082cb53b963149b72d7826ccc621bc6c2ece3765 Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Fri, 7 Jun 2019 23:08:56 +0100 Subject: [PATCH] update devnotes --- 3d_gpu/devnotes.mdwn | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/3d_gpu/devnotes.mdwn b/3d_gpu/devnotes.mdwn index 98d479330..95d966066 100644 --- a/3d_gpu/devnotes.mdwn +++ b/3d_gpu/devnotes.mdwn @@ -25,9 +25,14 @@ tests. unit tests always to be run prior to commit. * commits MUST be SINGLE PURPOSE. clue (red flag) is if the commit message includes the word "and". -* commit message to explain purpose (ie not be "changed this" or "added that") +* commit message to explain purpose (ie not be "changed this" or "added that"). + if rollback is ever needed (possibly even months later), the commit log + is only useful to find that one commit if the commit message is useful. * large commits ok as long as they are additions rather than modifications. -* whitespace to be separate, "autopep8 cleanup" is sufficient. + examples: a completely new class that is not in use anywhere, or a new unit + test. +* whitespace to be separate, commit msg "autopep8 cleanup" or + "whitespace cleanup" is sufficient. * when using bugtracker, include link to bugreport in commit message. Cross ref commit id to bugreport. * large refactoring (e.g. renaming functions) needs to be atomic and -- 2.30.2