External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-21 20:15:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Release notes should be updated in a separate commit

Browse Source 
Updating docs/news.xml in the same commit that performs the
documented change makes backports needlessly complicated,
both for mainteinance branches and downstream distributions,
because it introduces additional potential for merge
conflicts.

Document in the contributor guidelines that the release notes
should be updated in a separate commit instead, so that it's
easy to backport just the code change.
This commit is contained in:
Andrea Bolognani 2017-02-03 10:19:12 +01:00
parent f86a7a8372
commit 54eaf639a5
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/hacking.html.in
View File

@ -302,7 +302,8 @@
or fixing all but the most obscure bugs, must be (briefly) described
in a release notes entry; changes that are only relevant to other
libvirt developers, such as code refactoring, don't belong in the
release notes.</p>
release notes. Note that <code>docs/news.xml</code> should be updated
in its own commit not to get in the way of backports.</p>
</li>
</ol>