aliens

Author Topic: History of changes in repo  (Read 3308 times)

Offline michal

  • Commander
  • *****
  • Posts: 629
    • View Profile
History of changes in repo
« on: September 01, 2011, 08:29:16 am »
Hello,

I just thought that it could be nice to have file in repo/source describing changes in openxcom, something like that:
https://github.com/LearnBoost/socket.io/blob/master/History.md

That file should be included in package (beside readme.txt). It could be useful for users to see, what has changed in new version. Also, it would be easier to write announcement on main page - you could just paste part of that file ;)

Of course it's more work for programmers, cause every major changes should be described there ;)

Couple of examples from other projects:
https://svn.gna.org/viewcvs/*checkout*/wesnoth/tags/1.9.8/players_changelog
https://fheroes2.svn.sf.net/viewvc/fheroes2/trunk/fheroes2/changelog.txt?revision=2490&view=markup
https://vcmi.svn.sf.net/viewvc/vcmi/trunk/ChangeLog?revision=2317&view=markup

So, what do you think? Is it worth the effort?

Offline SupSuper

  • Lazy Developer
  • Administrator
  • Commander
  • *****
  • Posts: 2159
    • View Profile
Re: History of changes in repo
« Reply #1 on: September 01, 2011, 10:56:05 pm »
I usually only do this at release time skimming through all the Git logs and what not, but keeping a constant changelog might be more convenient, good idea. :)