[Libre-soc-bugs] [Bug 1126] How to document new bugs/issues

[bugzilla-daemon at libre-soc.org]

https://bugs.libre-soc.org/show_bug.cgi?id=1126

--- Comment #28 from Luke Kenneth Casson Leighton <lkcl at lkcl.net> ---
(In reply to Andrey Miroshnikov from comment #27)

> On another note, I need to add the point of having a summary comment in a
> completed bug 

well... yes and no.  if the task is obvious, no.
the way that Michiel put it is: if you *need* a long
summary, because it is useful (documentation) then do it,
but it is nothing to do with NLnet.

in other words a BRIEF maximum ONE paragraph summary,
even just one sentence, is more than enough.

but, also, if comment #0 has a TODO list and the TODO
list has all been changed to DONE, it is obviously
totally unnecessary to write pages and pages of report.

bottom line you have to be sensible here.

typically what i have done is follow ISO 9000.

* say what you are going to do (MoU Task description)
* do it                        (TODO list, comments, commits)
* say that you have done it    (close the bugreport)

now, the only reason for making even 2 paragraphs is if
you DID NOT DO THE WORK but instead did something else,
or only completed say 50%.  there you MUST provide a
SUMMARY explanation.  here is a good example:
https://bugs.libre-soc.org/show_bug.cgi?id=784#c43



> (to make a clear declaration that budget is justified, and
> make the job easier for any potential auditors):

https://lists.libre-soc.org/pipermail/libre-soc-dev/2023-October/005731.html

-- 
You are receiving this mail because:
You are on the CC list for the bug.