[Bf-committers] Simple steps to get an harmonious collaboration

[Ray Molenkamp]

I'm somewhat confused on the goal some of the (proposed?) rules.
But I'll just pick on the "Patch description should match the
commit message."-rule for now not to make this longer than it
needs to be. 

Most people are much more verbose in their patch description,
some have visual aids (images/clips), benchmark results, and
perhaps test files attached to them. Rich content is possible
and often used.

While commit messages are a much more somber endeavor, no rich
content and strict requirements on the formatting (50 chars
for the first line ie)

The guidance we offer for what should be in a patch [1]
and what should be in a commit message [2] also paint two
rather different pictures.

Personally, I welcome justifications in a diff on al the ways the
problem could have been solved, but were ultimately not chosen for
reason X, Y or  Z. While in commit messages I honestly only care for
"what does it do, how does it do it" when I'm bisecting I have
no interest whatsoever in learning about all the ways a certain
commit doesn't solve the issue.

Patch descriptions and commit messages just seem fundamentally
different things, and I struggle a bit on seeing why unifying
the two would be a "good thing"

I have similar concerns with many of the other rules on this list,
most seem perfectly fine rules on first sight, but without a clear
justification on how they contribute to.. [check notes] .. "harmonious
collaboration in the code review platform", its just a list of
seemingly oddball rules, I could add a "keyboard layout must be
set to dvorak while typing patch description" rule and it wouldn't
even look out of place.

--Ray

[1] https://wiki.blender.org/wiki/Process/Contributing_Code#Ingredients_of_a_Patch
[2] https://wiki.blender.org/wiki/Style_Guide/Commit_Messages


On 2021-06-01 5:05 a.m., Sergey Sharybin via Bf-committers wrote:
> Hi,
>
> Just a quick note. The bf-admin team worked on several process related
> documents to ensure a pleasant and efficient development process.
>
> Today we've updated wiki with the patch review process:
> https://wiki.blender.org/wiki/Process/Patch_Review
>
> Feedback is welcome.
>
> Best regards,
> - Sergey -
> --------------------------------------------------------------------
> Sergey Sharybin - sergey at blender.org - www.blender.org
> Principal Software Engineer, Blender
> Buikslotermeerplein 161, 1025 ET Amsterdam, the Netherlands
> _______________________________________________
> Bf-committers mailing list
> Bf-committers at blender.org
> https://lists.blender.org/mailman/listinfo/bf-committers