openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Document the release notes process for contributors 

Now that we have built a fairly solid process for dealing with
release notes, we should start pushing for contributors to
provide the relevant information along with their code:
documenting the process is clearly a requirement for this to
happen.
This commit is contained in:
Andrea Bolognani 2017-01-04 12:45:23 +01:00
parent 6a5b312730
commit 605e308c95
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
HACKING
View File

@ -226,6 +226,13 @@ to "tests/.valgrind.supp" in order to suppress the warning:
(10) Update tests and/or documentation, particularly if you are adding a new (10) Update tests and/or documentation, particularly if you are adding a new
feature or changing the output of a program. feature or changing the output of a program.
(11) Don't forget to update the release notes <news.html> by changing
"docs/news.xml" if your changes are significant. All user-visible changes,
such as adding new XML elements 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.
There is more on this subject, including lots of links to background reading There is more on this subject, including lots of links to background reading
on the subject, on Richard Jones' guide to working with open source projects on the subject, on Richard Jones' guide to working with open source projects
<http://people.redhat.com/rjones/how-to-supply-code-to-open-source-projects/>. <http://people.redhat.com/rjones/how-to-supply-code-to-open-source-projects/>.

10
docs/hacking.html.in
View File

@ -294,6 +294,16 @@
<p>Update tests and/or documentation, particularly if you are adding <p>Update tests and/or documentation, particularly if you are adding
a new feature or changing the output of a program.</p> a new feature or changing the output of a program.</p>
</li> </li>
<li>
<p>Don't forget to update the <a href="news.html">release notes</a>
by changing <code>docs/news.xml</code> if your changes are
significant. All user-visible changes, such as adding new XML elements
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>
</li>
</ol> </ol>
<p> <p>