]> Kevux Git Server - rit/commit
CodingGuidelines: document NEEDSWORK comments
authorJunio C Hamano <gitster@pobox.com>
Thu, 12 Feb 2026 21:22:56 +0000 (13:22 -0800)
committerJunio C Hamano <gitster@pobox.com>
Sat, 14 Feb 2026 15:37:33 +0000 (07:37 -0800)
commitaa94ba7d80c3b917a507f6975bd6400436fcd9e6
tree6552b3c453b530b68825debd13934887b401de6b
parent9a2fb147f2c61d0cab52c883e7e26f5b7948e3ed
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>
Documentation/CodingGuidelines