[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 #51 from Dmitry Selyutin <ghostmansd at gmail.com> ---
(In reply to Luke Kenneth Casson Leighton from comment #50)
> 
> risk: "added file X. changed file Y". the commit diff shows you
> precisely and exactly that. it is considered bad practice.
> 
> better: bugNum: summary.
> 

Let me disagree. Not all issues refer to an actual bug. I agree this is a good
information to have, but not in the title, rather in the description. As for
changes on multiple files, that's exactly why I tend to use subsystem's name,
not the files. We generally modify the subsystem's behaviour, not just modify
random files.

> if people are not referring to the actual bug for context we have a
> serious problem.
> 
> in any series of commits i tend to make sure one of them has the
> full bugrport URL. it generally depends on how important the change
> is as to whether i put the full URL or not

We might opt to introduce a git hook which mandates this based on some
conditions, e.g. when there are too many changed lines. But generally I'd avoid
enforcing this everywhere, some fixes might be trivial or drive-by ones.


After all, commiting is about a commitment, people should enjoy doing this. If
we impose too strict guidelines, this would simply freak out the contributors.

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