diff --git a/HACKING b/HACKING index c2cb03799b..ff545a8fac 100644 --- a/HACKING +++ b/HACKING @@ -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 feature or changing the output of a program. +(11) Don't forget to update the release notes 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 on the subject, on Richard Jones' guide to working with open source projects . diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 47475a25a3..c7bbcbd467 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -294,6 +294,16 @@

Update tests and/or documentation, particularly if you are adding a new feature or changing the output of a program.

+ +
  • +

    Don't forget to update the release notes + 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.

    +