[Development] How to relate patch to bug report?

[Thiago Macieira]

On Friday 22 November 2024 10:40:14 Pacific Standard Time Stan Morris wrote:
> I am working on a patch for a bug report (590520
> <https://codereview.qt-project.org/c/qt/qtdeclarative/+/590520> for
> QTBUG-126835 <https://bugreports.qt.io/browse/QTBUG-126835>). Is there
> something I should do to relate the patch and the bug to each other beyond
> documenting "Task-number:" in the code review commit message? Should I ask
> the bug be assigned to me when I am not a Qt Company employee? Is it okay
> to put a comment in the bug report that says "I have a patch, #######, that
> addresses this defect so other developers can see a solution to the bug?

Hello Stan

Thank you for the contribution! You don't need to write anything extra; your 
commit message is what will show up in the Git log and, for that, your first 
contribution should be written like someone's 4000th. There's no difference!

Write either "Task-number" or "Fixes" at the commit message footer and that is 
enough. Someone can assign the bug to you as you're working on it, but it's 
not necessary. The bot will close the bug if you used "Fixes".

> I didn't
> have a Gerrit Buddy to answer noob questions like the one in the subject
> line.

Subject line goes in the imperative and says what you're trying to make the 
code do. [ChangeLog] (if applicable, and fixing a bug usually is) goes in the 
past tense and explains to a user reading the changelog what changed for them; 
usually a "fixed a bug that ..." is a good start. The message body should 
explain why you're making this particular change, not describe the code. We 
can read diffs :-)

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Principal Engineer - Intel DCAI Platform & System Engineering
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 5152 bytes
Desc: not available
URL: <http://lists.qt-project.org/pipermail/development/attachments/20241123/a4e26d76/attachment.bin>