Hi Simon, Simon Josefsson via Gnulib discussion list <[email protected]> writes:
> "Basil L. Contovounesios" <[email protected]> writes: > >> Automake 1.16.4 introduced the option of keeping a NEWS.md file. > ... >> Before pursuing this further, I was hoping to get some feedback on >> whether changes in this direction are welcome > > +1 from me. > > Would it make sense to add a recomended NEWS(.md) file format style > guide to the gnulib manual? I think there is quite some standardized > patterns going on here re the release version/date line. The same > section could suggest a markdown style to use, so we get some > consistency across packages. For libraries we can suggest the API/ABI > changes section that are in common use. > > Btw, I made README a symlink to README.md in several packages, and it > seems to work fine. I'm hoping NEWS can be a symlink to NEWS.md, or > maybe even that I don't need a symlink at all and renaming NEWS to > NEWS.md (and make markup changes) will work? Sending this to [email protected] since NEWS is documented in the GNU Coding Standards, not Gnulib [1]. Based on my reading of it, the important part of the NEWS file is the changes being listed, not the format of the file itself. Most of GNU projects I have looked at use 'outline-mode' from Emacs. But Markdown and other similar formats (e.g. reStructuredText, Org Mode) are perfectly readable as plain text. Therefore, I think it would be okay to allow other formats. I like the idea of a symlink, but those can't be included in releases [2]. Collin [1] https://www.gnu.org/prep/standards/html_node/NEWS-File.html [2] https://www.gnu.org/prep/standards/html_node/Releases.html
