CodingGuidelines: document NEEDSWORK comments
We often say things like /* NEEDSWORK: further _do_ _this_ */ in comments, but it is a short-hand to say "We might later want to do this. We might not. We do not have to decide it right now at this moment in the commit this comment was added. If somebody is inclined to work in this area further, the first thing they need to do is to figure out if it truly makes sense to do so, before blindly doing it." This seems to have never been documented. Do so now. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Feb 12, 2026 at 13:22 UTC
aa94ba7d80c3b917a507f6975bd6400436fcd9e6
1 file changed
+10
Documentation/CodingGuidelines
+10
@@ -33,6 +33,16 @@ Git in general, a few rough rules are:
33
achieve and why the changes were necessary (more on this in the
34
accompanying SubmittingPatches document).
35
36
+ - A label "NEEDSWORK:" followed by a description of the things to
37
+ be done is a way to leave in-code comments to document design
38
+ decisions yet to be made. 80% of the work to resolve a NEEDSWORK
39
+ comment is to decide if it still makes sense to do so, since the
40
+ situation around the codebase may have changed since the comment
41
+ was written. It can be a very valid change to remove an existing
42
+ NEEDSWORK comment without doing anything else, with the commit log
43
+ message describing a good argument why it does not make sense to do
44
+ the thing the NEEDSWORK comment mentioned.
45
+
46
Make your code readable and sensible, and don't try to be clever.
47
48
As for more concrete guidelines, just imitate the existing code