[Rails-devel] Todo lists, release notes and the Wiki

[Erik V. <eri...@xs...>]

> -----Original Message-----
> From: Stefan Frey [mailto:ste...@we...]
> Sent: Thursday, July 14, 2011 7:51 AM
> To: Development list for Rails: an 18xx game
> Subject: Re: [Rails-devel] Refactored loading code
> 
> This seems like duplication of work: The repository already keeps a
history of
> the change-logs. I believe it will be the same for git. Thus I am
reluctant to
> copy the logs into the wiki manually.

The wiki change log is intended as raw material for Release Notes.  Brett
did that for 1.4.1, and I did it for 1.4.2.  I personally find the separate
log easier to work with, and it also allows me to add the names of the
people who have contributed to each change.  

> What I think would be helpful (and I did that once already) to attach the
> revision number after the e-mail accompanying the commit (if there is
any).
> In combination with blame this would really help to find out, what was the
> idea behind the change. I quite often search the Rails archive for more
info of
> a change.
> 
> I have not checked if there is a revision number of the sf-git repository
and
> potentially it might be better to copy the main parts of the e-mail into
> (additional) javadoc document(s).

No, unfortunately we will lose the revision numbers.  Git identifies changes
with 32 hex digit hashes of their contents, and I read that it is somewhat
conventional to use the first 6 characters of these hashes to identify
changes in human interactions.  I'm not aware of any method to humanize that
any further.
 
> Instead of adding the history of development to the wiki I suggest to add
a
> development roadmap/todo-list to the wiki.
> Especially with local repositories it gets more likely that several people
are
> working on the same stuff, which is both a waste of resources and makes
> code merging difficult. And it might even attract new people, if they know
> where to start and what is needed.

Yeah, various people have already done bits of that, but it needs more work.


Now that I have paused development until the transfer to Git has completed,
I'm digging through my enormous Inbox to collect and group the requests and
ideas for generic actions per subject and specific actions per game.  My
hope is that this will help to get myself organized a bit better (not my
best skill, I must admit), and perhaps I could use it as base material for
the Wiki.  

Erik.

 
> Stefan
> 
> 
> 
> >
> > As you may or may not have noticed, since some time I'm pretty
> > meticulously creating entries in the Wiki Change Log for all my
> > commits (except very trivial ones).  I don't know if I can expect the
> > same from Brett and you (as we have seen earlier today, I'm not really
> > the right person to request discipline). In any case, I have just
> > created simple entries for the recent commits 1602-1604 by the two of
> > you.  Feel free to  correct or expand.