Hi there, Right now Backwards Incompatible changes are documented in a wiki page, with some disadvantages:
* There's a reference in documentation to the wiki (install.txt:182)
* When commiting those changes the wiki has to be updated by hand.
* Some people expect either a Changelog or UPDATE file to live in the
source tree of a project, it's a common practice.
* Packagers would have to either refer to it, or copy the page to a doc
folder.
Including an UPDATE.txt file (either in the root folder or in docs/)
could provide some advantages:
* Patches could provide the necesary notes to this file if needed so
the commiter would not need to edit the wiki.
* The file can be included in releases so everybody gets it
* It's really easy to find such file, specially in the root folder
* The documentation could, simply, include this file
I think that the nicest advantage is the first one, as patches do
already have to provide documentation it's not that hard to document if
a patch is supposed to break something, and that could take out some
work load from commiters.
If you like the idea I volunteer to compile an initial UPDATE.txt and a
diff for contributing.txt pointing about that (and filling a ticket!)
Awaitting your comments,
Marc
PS: Anybody knows if malcolm is ok? (just worried, offline for one-two
months).
--
http://www.marcfargas.com -- will be finished some day.
signature.asc
Description: Esta parte del mensaje está firmada digitalmente
