External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update best practices wrt "Fixes:" and GitLab

Browse Source 
We document that a commit fixing an issue tracked in GitLab
should put just "Fixes: #NNN" into its commit message. But when
viewing git log, having full URL which is directly clickable is
more developer friendly and GitLab is capable of handling both.
Therefore, document that users should put full URL, just like
when fixing a bug tracked in other sites.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
Michal Privoznik 2022-10-24 13:45:23 +02:00
parent 045072ee3a
commit 42b2f1f8b8
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/best-practices.rst
View File

@ -14,12 +14,12 @@ with minimal back-and-forth.
(60 characters is typical), followed by a blank line, followed (60 characters is typical), followed by a blank line, followed
by any longer description of why your patch makes sense. If the by any longer description of why your patch makes sense. If the
patch fixes a regression, and you know what commit introduced patch fixes a regression, and you know what commit introduced
the problem, mentioning that is useful. If the patch resolves a the problem, mentioning that is useful. If the patch resolves
upstream bug reported in GitLab, put "Fixes: #NNN" in the commit an upstream bug reported in GitLab, or downstream bug, put
message. For a downstream bug, mention the URL of the bug instead. "Resolves: $fullURL" of the bug. In both cases also summarize
In both cases also summarize the issue rather than making all the issue rather than making all readers follow the link. You
readers follow the link. You can use 'git shortlog -30' to get can use 'git shortlog -30' to get an idea of typical summary
an idea of typical summary lines. lines.
- Split large changes into a series of smaller patches, - Split large changes into a series of smaller patches,
self-contained if possible, with an explanation of each patch self-contained if possible, with an explanation of each patch