From: brett l. <wak...@gm...> - 2010-02-03 22:03:13
|
As we're all probably aware, CVS is ancient technology. Rails is only really using it because it was the default for a Sourceforge project when I signed up. After nearly 5 years of development, our repository has gotten a bit crufty and is starting to show some of it's warts. Performance doing checkouts has started to suffer a bit. What do you guys think about looking at other options? For the last year at $dayjob, I've been using Git (http://git-scm.com) a lot, and I really enjoy it. Looks like there's an Eclipse plugin for git (http://www.eclipse.org/egit/). Sourceforge supports using Subversion, Git, Mercurial, Bazaar, and CVS. I've personally got experience with CVS, Subversion, and Git. I've only used Mercurial once or twice, which isn't enough to really have an opinion of it. Overall, my experience is that Git is light years ahead of CVS and Subversion. What are everyone else's thoughts and experiences? Is this something worth doing? Do you want to stay with CVS? Do you hate me because you're a new committer and you just got your environment set up, and now I'm proposing changing it? ;-) ---Brett. |
From: Rick W. <wes...@pu...> - 2010-02-03 22:10:47
|
> > Overall, my experience is that Git is light years ahead of CVS and > Subversion. > > What are everyone else's thoughts and experiences? > Is this something worth doing? > Do you want to stay with CVS? > Do you hate me because you're a new committer and you just got your > environment set up, and now I'm proposing changing it? ;-) I suspect that this is something that needs to be done sooner or later. So sooner is better before even more people have to make the change. Personally I have not used git -- only subversion and cvs -- but have heard good things about git. -- Rick |
From: Stefan F. <ste...@we...> - 2010-02-03 22:25:22
|
one of the new ones: Moving away from CVS seems to be a good idea. I use subversion at work, git was not available at the time of setting up. From my point of view I am quite happy with it, but I am not a power user and I do not need distributed repos. As I am not a regular user of eclipse a seamless and reliable integration would help a lot. Stefan On Wednesday 03 February 2010 23:12:49 Rick Westerman wrote: > > Overall, my experience is that Git is light years ahead of CVS and > > Subversion. > > > > What are everyone else's thoughts and experiences? > > Is this something worth doing? > > Do you want to stay with CVS? > > Do you hate me because you're a new committer and you just got your > > environment set up, and now I'm proposing changing it? ;-) > > I suspect that this is something that needs to be done sooner or > later. So sooner is better before even more people have to make the > change. Personally I have not used git -- only subversion and cvs -- > but have heard good things about git. > > -- Rick > > > --------------------------------------------------------------------------- >--- The Planet: dedicated and managed hosting, cloud storage, colocation > Stay online with enterprise data centers and the best network in the > business Choose flexible plans and management services without long-term > contracts Personal 24x7 support from experience hosting pros just a phone > call away. http://p.sf.net/sfu/theplanet-com > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel |
From: John A. T. <ja...@ja...> - 2010-02-03 22:22:59
|
On Wed, Feb 3, 2010 at 5:02 PM, brett lentz <wak...@gm...> wrote: > I've personally got experience with CVS, Subversion, and Git. I've > only used Mercurial once or twice, which isn't enough to really have > an opinion of it. > > Overall, my experience is that Git is light years ahead of CVS and > Subversion. > I would agree CVS is ancient and to be avoided in anything but personal projects. Between git and svn, I would say it depends on what you are doing. I am a long time Unix user, and to me git feels like the Unix command line philosophy -- lots of small tools that you piece together to get what you want. That is good in some ways in that you gain a lot of flexibility in how you put the pieces together, but it is bad in that it feels lower level and you have to do more steps for common tasks. The other big difference is it is more of a distributed model, where individual people can have their own repositories and commit to them, which is good when they aren't contributors in the main project. I don't know about Sourceforge's svn controls, but at least on code.google.com you can't have people with commit access to subtrees of the repository, which is how svn users accomplish similar tasks by having their own change branches for large changes. That means you have to give them commit access anyway and trust that they won't commit elsewhere without proper review, but you can always rollback any changes that shouldn't have been made and revoke commit access if they do. > What are everyone else's thoughts and experiences? > Is this something worth doing? > Do you want to stay with CVS? > Do you hate me because you're a new committer and you just got your > environment set up, and now I'm proposing changing it? ;-) > I think either svn or git would be fine and both have good Eclipse plugins. I haven't used Hg, so I don't know if it would be better or worse. The last time I used Bazaar it was buggy, which is far from what you want in your version control system. I personally use svn for most everything, but if you don't have commit access for change branches it can be a pain to work on large changes that you want to checkpoint status on before it is ready to send for review. -- John A. Tamplin |
From: brett l. <wak...@gm...> - 2010-02-03 22:34:40
|
On Wed, Feb 3, 2010 at 2:17 PM, John A. Tamplin <ja...@ja...> wrote: > On Wed, Feb 3, 2010 at 5:02 PM, brett lentz <wak...@gm...> wrote: >> >> I've personally got experience with CVS, Subversion, and Git. I've >> only used Mercurial once or twice, which isn't enough to really have >> an opinion of it. >> >> Overall, my experience is that Git is light years ahead of CVS and >> Subversion. > > I would agree CVS is ancient and to be avoided in anything but personal > projects. > Between git and svn, I would say it depends on what you are doing. I am a > long time Unix user, and to me git feels like the Unix command line > philosophy -- lots of small tools that you piece together to get what you > want. That is good in some ways in that you gain a lot of flexibility in > how you put the pieces together, but it is bad in that it feels lower level > and you have to do more steps for common tasks. The other big difference is > it is more of a distributed model, where individual people can have their > own repositories and commit to them, which is good when they aren't > contributors in the main project. I don't know about Sourceforge's svn > controls, but at least on code.google.com you can't have people with commit > access to subtrees of the repository, which is how svn users accomplish > similar tasks by having their own change branches for large changes. That > means you have to give them commit access anyway and trust that they won't > commit elsewhere without proper review, but you can always rollback any > changes that shouldn't have been made and revoke commit access if they do. > > -- > John A. Tamplin It seems that many people get hung up on the "distributed" piece when talking about git, hg, and bzr. Really, the only thing being "distributed" means, is that there's no technical restrictions that enforce a client/server model. However, it's still very easy to have a development model that designates one repository as "master" or "authoritative", and have everyone's commits funnel through that repository. That's actually what we do at $dayjob. We have a central git repository server that everyone pushes their changes into. We don't publish our personal repositories for merging our various development trees. We can, we just don't. For our use case, it just wouldn't help us any. So... other than being able to share your work before it goes into the "master" tree, the whole distributed thing isn't really a big deal. ---Brett. |
From: Chris B. <bro...@co...> - 2010-02-03 23:09:32
|
On Wed, Feb 3, 2010 at 2:34 PM, brett lentz <wak...@gm...> wrote: > That's actually what we do at $dayjob. We have a central git > repository server that everyone pushes their changes into. We don't > publish our personal repositories for merging our various development > trees. We can, we just don't. For our use case, it just wouldn't > help us any. > My experience is the same as yours Brett, and I'm a big fan of git. It takes a while to "get git" but once you do the model is very compelling. And having the easy *option* to commit/share/branch peer-to-peer without a central server can be very handy in circumstances where you need it. -Chris |
From: Erik V. <eri...@xs...> - 2010-02-03 23:10:14
|
I have only a little experience with SVN, and none with Git, so I can't offer much help in this decision. Most important for me is ease of use from Eclipse and the quality of the integration with Eclipse. With SVN, I have found that I also needed TortoiseSVN to resolve some conflicts that I could't fix from Eclipse (these problems were probably caused by my own undisciplined use of SVN). Erik. -----Original Message----- From: brett lentz [mailto:wak...@gm...] Sent: Wednesday 03 February 2010 23:03 To: Development list for Rails: an 18xx game Subject: [Rails-devel] Idea: migrating away from cvs. As we're all probably aware, CVS is ancient technology. Rails is only really using it because it was the default for a Sourceforge project when I signed up. After nearly 5 years of development, our repository has gotten a bit crufty and is starting to show some of it's warts. Performance doing checkouts has started to suffer a bit. What do you guys think about looking at other options? For the last year at $dayjob, I've been using Git (http://git-scm.com) a lot, and I really enjoy it. Looks like there's an Eclipse plugin for git (http://www.eclipse.org/egit/). Sourceforge supports using Subversion, Git, Mercurial, Bazaar, and CVS. I've personally got experience with CVS, Subversion, and Git. I've only used Mercurial once or twice, which isn't enough to really have an opinion of it. Overall, my experience is that Git is light years ahead of CVS and Subversion. What are everyone else's thoughts and experiences? Is this something worth doing? Do you want to stay with CVS? Do you hate me because you're a new committer and you just got your environment set up, and now I'm proposing changing it? ;-) ---Brett. ---------------------------------------------------------------------------- -- The Planet: dedicated and managed hosting, cloud storage, colocation Stay online with enterprise data centers and the best network in the business Choose flexible plans and management services without long-term contracts Personal 24x7 support from experience hosting pros just a phone call away. http://p.sf.net/sfu/theplanet-com _______________________________________________ Rails-devel mailing list Rai...@li... https://lists.sourceforge.net/lists/listinfo/rails-devel |
From: Phil D. <de...@gm...> - 2010-02-04 02:46:03
|
I have better familiarity with SVN than anything else but frankly if you point me in the direction of an appropriate guide that's decently written I'll happily go with whatever anyone else wants On 3 February 2010 23:10, Erik Vos <eri...@xs...> wrote: > I have only a little experience with SVN, and none with Git, so I can't > offer much help in this decision. > > Most important for me is ease of use from Eclipse and the quality of the > integration with Eclipse. > With SVN, I have found that I also needed TortoiseSVN to resolve some > conflicts that I could't fix from Eclipse > (these problems were probably caused by my own undisciplined use of SVN). > > Erik. > > > -----Original Message----- > From: brett lentz [mailto:wak...@gm...] > Sent: Wednesday 03 February 2010 23:03 > To: Development list for Rails: an 18xx game > Subject: [Rails-devel] Idea: migrating away from cvs. > > As we're all probably aware, CVS is ancient technology. Rails is > only really using it because it was the default for a Sourceforge > project when I signed up. > > After nearly 5 years of development, our repository has gotten a bit > crufty and is starting to show some of it's warts. Performance doing > checkouts has started to suffer a bit. > > What do you guys think about looking at other options? > > For the last year at $dayjob, I've been using Git (http://git-scm.com) > a lot, and I really enjoy it. Looks like there's an Eclipse plugin > for git (http://www.eclipse.org/egit/). > > Sourceforge supports using Subversion, Git, Mercurial, Bazaar, and CVS. > > I've personally got experience with CVS, Subversion, and Git. I've > only used Mercurial once or twice, which isn't enough to really have > an opinion of it. > > Overall, my experience is that Git is light years ahead of CVS and > Subversion. > > What are everyone else's thoughts and experiences? > Is this something worth doing? > Do you want to stay with CVS? > Do you hate me because you're a new committer and you just got your > environment set up, and now I'm proposing changing it? ;-) > > ---Brett. > > ---------------------------------------------------------------------------- > -- > The Planet: dedicated and managed hosting, cloud storage, colocation > Stay online with enterprise data centers and the best network in the > business > Choose flexible plans and management services without long-term contracts > Personal 24x7 support from experience hosting pros just a phone call away. > http://p.sf.net/sfu/theplanet-com > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > > > ------------------------------------------------------------------------------ > The Planet: dedicated and managed hosting, cloud storage, colocation > Stay online with enterprise data centers and the best network in the business > Choose flexible plans and management services without long-term contracts > Personal 24x7 support from experience hosting pros just a phone call away. > http://p.sf.net/sfu/theplanet-com > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > |
From: Freek D. <sf_...@ma...> - 2010-02-04 09:10:45
|
Erik Vos wrote: > I have only a little experience with SVN, and none with Git, so I can't > offer much help in this decision. I have experiences in both subversion and git. Mercurial and Bazaar are new to me. Like most people, getting to understand git took a little while, but once I got it running, I like it. For most of my personal projects, I still use subversion, but in my view subversion is lacking the ability for branching and tagging. The naming of commands is a bit different in CVS and git. (while SVN is very similar to git). I made this page for my own personal reference: http://www.macfreek.nl/mindmaster/Version_Control_Basics There are two things to keep in mind: - git stores the full repository locally, not just the latest revision like svn and cvs do. - in order to "upload" a file with git, you first have to add the file to register changes, then commit (which is local), finally push. This seemed complex to me at first, but over time I grew to like it. Regards, Freek |
From: Freek D. <sf_...@ma...> - 2010-02-04 09:19:53
|
Freek Dijkstra wrote: > The naming of commands is a bit different in CVS and git. (while SVN is > very similar to git). I meant to say "very similar to CVS", of course. |
From: brett l. <wak...@gm...> - 2010-02-04 04:04:42
|
OK. The thoughts are generally favorable, so I'll start planning a migration. My basic plan is going to be something like this: 1. Test out the Git plugin for Eclipse. If the UI is similar enough to the CVS integration, we'll go with Git. 2. If Git doesn't work out for some reason, my second choice would be Mercurial. So, I'd look into that. 3. If both options fail for some reason, I'll punt and go with Subversion. It at least sucks marginally less than CVS. (you can actually delete directories in SVN!) ---Brett. On Wed, Feb 3, 2010 at 3:10 PM, Erik Vos <eri...@xs...> wrote: > I have only a little experience with SVN, and none with Git, so I can't > offer much help in this decision. > > Most important for me is ease of use from Eclipse and the quality of the > integration with Eclipse. > With SVN, I have found that I also needed TortoiseSVN to resolve some > conflicts that I could't fix from Eclipse > (these problems were probably caused by my own undisciplined use of SVN). > > Erik. > > > -----Original Message----- > From: brett lentz [mailto:wak...@gm...] > Sent: Wednesday 03 February 2010 23:03 > To: Development list for Rails: an 18xx game > Subject: [Rails-devel] Idea: migrating away from cvs. > > As we're all probably aware, CVS is ancient technology. Rails is > only really using it because it was the default for a Sourceforge > project when I signed up. > > After nearly 5 years of development, our repository has gotten a bit > crufty and is starting to show some of it's warts. Performance doing > checkouts has started to suffer a bit. > > What do you guys think about looking at other options? > > For the last year at $dayjob, I've been using Git (http://git-scm.com) > a lot, and I really enjoy it. Looks like there's an Eclipse plugin > for git (http://www.eclipse.org/egit/). > > Sourceforge supports using Subversion, Git, Mercurial, Bazaar, and CVS. > > I've personally got experience with CVS, Subversion, and Git. I've > only used Mercurial once or twice, which isn't enough to really have > an opinion of it. > > Overall, my experience is that Git is light years ahead of CVS and > Subversion. > > What are everyone else's thoughts and experiences? > Is this something worth doing? > Do you want to stay with CVS? > Do you hate me because you're a new committer and you just got your > environment set up, and now I'm proposing changing it? ;-) > > ---Brett. > > ---------------------------------------------------------------------------- > -- > The Planet: dedicated and managed hosting, cloud storage, colocation > Stay online with enterprise data centers and the best network in the > business > Choose flexible plans and management services without long-term contracts > Personal 24x7 support from experience hosting pros just a phone call away. > http://p.sf.net/sfu/theplanet-com > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > > > ------------------------------------------------------------------------------ > The Planet: dedicated and managed hosting, cloud storage, colocation > Stay online with enterprise data centers and the best network in the business > Choose flexible plans and management services without long-term contracts > Personal 24x7 support from experience hosting pros just a phone call away. > http://p.sf.net/sfu/theplanet-com > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > |
From: Erik V. <eri...@xs...> - 2010-02-04 20:34:41
|
1. Test out the Git plugin for Eclipse. If the UI is similar enough to the CVS integration, we'll go with Git. ------------- [EV] While reading around on Git an Egit, the following worried me: Pulling (merge or rebase) new changes from upstream This is not yet available. Available alternatives currently include: * run "git pull" from outside eclipse (but beware on Windows) * if you did no local change or want to discard your local changes, use "Team/Reset To..." Retrieved from "http://wiki.eclipse.org/EGit/User_Guide/Remote" Does this mean that Egit (the Eclipse plugin) has no equivalent for CVS update from a remote repository? That would rule it out for me. I don't want to be condemned to use the (Windows) command line. For the rest, I don't care for the distributed model - I don't see why I would need a local repository. But I trust you if you say that it can be easily bypassed. Erik. |
From: brett l. <wak...@gm...> - 2010-02-04 21:09:52
|
On Thu, Feb 4, 2010 at 12:34 PM, Erik Vos <eri...@xs...> wrote: > 1. Test out the Git plugin for Eclipse. If the UI is similar enough > to the CVS integration, we'll go with Git. > ------------- > > [EV] While reading around on Git an Egit, the following worried me: > > Pulling (merge or rebase) new changes from upstream > > This is not yet available. Available alternatives currently include: > > * run "git pull" from outside eclipse (but beware on Windows) > * if you did no local change or want to discard your local > changes, use "Team/Reset To..." > > Retrieved from "http://wiki.eclipse.org/EGit/User_Guide/Remote" > > Does this mean that Egit (the Eclipse plugin) has no equivalent for CVS > update from a remote repository? > That would rule it out for me. I don't want to be condemned to use the > (Windows) command line. > > For the rest, I don't care for the distributed model - I don't see why I > would need a local repository. > But I trust you if you say that it can be easily bypassed. > > Erik. > > wow... that's a major part of the git work flow that they haven't implemented. i'm kind of surprised by that. ---Brett. |
From: brett l. <wak...@gm...> - 2010-02-04 21:18:50
|
On Thu, Feb 4, 2010 at 1:09 PM, brett lentz <wak...@gm...> wrote: > On Thu, Feb 4, 2010 at 12:34 PM, Erik Vos <eri...@xs...> wrote: >> 1. Test out the Git plugin for Eclipse. If the UI is similar enough >> to the CVS integration, we'll go with Git. >> ------------- >> >> [EV] While reading around on Git an Egit, the following worried me: >> >> Pulling (merge or rebase) new changes from upstream >> >> This is not yet available. Available alternatives currently include: >> >> * run "git pull" from outside eclipse (but beware on Windows) >> * if you did no local change or want to discard your local >> changes, use "Team/Reset To..." >> >> Retrieved from "http://wiki.eclipse.org/EGit/User_Guide/Remote" >> >> Does this mean that Egit (the Eclipse plugin) has no equivalent for CVS >> update from a remote repository? >> That would rule it out for me. I don't want to be condemned to use the >> (Windows) command line. >> >> For the rest, I don't care for the distributed model - I don't see why I >> would need a local repository. >> But I trust you if you say that it can be easily bypassed. >> >> Erik. >> >> > > wow... that's a major part of the git work flow that they haven't > implemented. i'm kind of surprised by that. > > ---Brett. > Ah ha. After some more googling, I see why. "git pull" is synonymous with "git fetch && git merge". In plain english, "Fetch remote changesets, and update the database. Then, if that succeeds, update the local working copy with the updated changes." Egit didn't have a merge algorithm implemented yet. However, I found this: http://egit.eclipse.org/r/#change,140 Looks like they've finally gotten a merge algorithm implemented, which means 'git pull' is probably going to show up in the next version or two. Awesome. I'm not planning on doing the migrations _today_, so we can take our time testing out eGit and see if they can get the feature added sometime in the next month or two. ---Brett. |
From: John D. G. <jd...@di...> - 2010-02-10 06:04:32
|
On 2010-02-03 14:02, brett lentz wrote: > What are everyone else's thoughts and experiences? > Is this something worth doing? > Do you want to stay with CVS? > Do you hate me because you're a new committer and you just got your > environment set up, and now I'm proposing changing it? ;-) I'm not even that far along yet, but certainly a change will delay my being able to participate. It would help if there were a FAQ about how to set up a build environment compatible with the code (so I can test my ideas before submitting them). Check-in is a secondary consideration; I assume once I have code working there will be someone willing to check it in from a "diff" or the like. |
From: Rick W. <wes...@pu...> - 2010-02-10 15:45:10
|
John David Galt wrote: > On 2010-02-03 14:02, brett lentz wrote: > >> What are everyone else's thoughts and experiences? >> Is this something worth doing? >> Do you want to stay with CVS? >> Do you hate me because you're a new committer and you just got your >> environment set up, and now I'm proposing changing it? ;-) >> > > I'm not even that far along yet, but certainly a change will delay my being > able to participate. > > It would help if there were a FAQ about how to set up a build environment > compatible with the code (so I can test my ideas before submitting them). > I suspect the feeling is that if you are competent enough to code in Java then you are competent enough to set up a build environment. I believe that most people use Eclipse as their IDE. Myself? I still use 'vi' and then 'ant' to build everything -- this is either from my Mac and Linux machines. But then I am not making many modifications to the code but rather trying to create new game titles via small changes. Now what is missing is an overall view of what the various files do and what helper programs have been created. I was working on such a document but, alas, despite the winter weather I have not had time to follow through on said document. Of course if you see a need for a FAQ then by all means create one and submit it. -- Rick Westerman wes...@pu... Bioinformatics specialist at the Genomics Facility. Phone: (765) 494-0505 FAX: (765) 496-7255 Department of Horticulture and Landscape Architecture 625 Agriculture Mall Drive West Lafayette, IN 47907-2010 Physically located in room S049, WSLR building |
From: Freek D. <sf_...@ma...> - 2010-02-10 18:47:27
|
Rick Westerman wrote: > Now what is missing is an overall view of what the various files do > and what helper programs have been created. I was working on such a > document but, alas, despite the winter weather I have not had time to > follow through on said document. Hi Rick, Care to collaborate on such documentation? I presume the audience is developers rather than users for now. I asked a few questions, and got some great answers by Erik and Brett. However, some things are not obvious, or outdated. What do you like to improve? 1. Update the visio file with the class hierarchy (which seems outdated at the moment) 2. Document the folder structure. In most projects, the folder structure seems to be grouped like this: * source code * data files for inclusion in the program * tools and documentation to be included with the program * tools and scripts for creating various builds * build folder (created by the build environment) However, the current rails folder structure does not follow this approach. For example the tiles folder contains both tools for generation as well as the final output, even though I had expected to go in the "data" folder as I had expected. 3. Document the build process. I found that the Eclipse build process is quite different from the ant build process, although they use the same folders. It is possible to integrate these (both by calling ant from within Eclipse or using the incremental Java builder from ant). However, I am not sure if it would gain us anything by integrating these processes, so I wonder if we should either integrate it more or differentiate it (using different folders; I found that eclipse sometimes does not register changed files created by an ant build). However, I did put this on hold for now (I got a little girl at home, and my wife started working again last week, so free time is a scare resource right now). PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to build stuff. However, I am also using eclipse for debugging. Do you use any debugging, and if so, using what tools? Regards, Freek |
From: Stefan F. <ste...@we...> - 2010-02-10 22:11:56
|
I assume limited time is a common feature ;-) and most of the time the best reason for missing documentation... As I had to get myself familiar with the code and structure, I put down some notes already, which would need some polishing for others to understand. My take on doc is: The best and up-to-date documentation of the code is the code itself. Improving the code improves the documentation. Second best for code documenation is adding documentation in Javadoc comments. For higher-level documentation (for rails e.g. how to prepare XML files, design tiles, build the project, user documentation etc.) I prefer wikis for joint projects. Has anyone thought about setting up a wiki on sourceforge for Rails? Stefan On Wednesday 10 February 2010 22:48:59 Rick Westerman wrote: > > Care to collaborate on such documentation? I presume the audience is > > developers rather than users for now. > > Yes. Specifically for people who would want to add a new game to Rails > without having to do much extra coding. In other words perhaps a game > based on 1830 with parts from 1835 and 1870. Or something not too radical. > > > What do you like to improve? > > > > > > 2. Document the folder structure. > > Yes. This. Folder structure and what files are in the structure. > > I do not see a need to change the folder structure to "best practices". > Rather I am willing to work with it as it is. > > > PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to > > build stuff. However, I am also using eclipse for debugging. Do you use > > any debugging, and if so, using what tools? > > No debugging so far. But then I am not doing major modifications to the > java code. > > > My time is limited as well. I will try to upload what I do have later > tonight. |
From: Rick W. <wes...@pu...> - 2010-02-10 21:49:06
|
> > Care to collaborate on such documentation? I presume the audience is > developers rather than users for now. Yes. Specifically for people who would want to add a new game to Rails without having to do much extra coding. In other words perhaps a game based on 1830 with parts from 1835 and 1870. Or something not too radical. > > What do you like to improve? > > > 2. Document the folder structure. Yes. This. Folder structure and what files are in the structure. I do not see a need to change the folder structure to "best practices". Rather I am willing to work with it as it is. > PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to > build stuff. However, I am also using eclipse for debugging. Do you use > any debugging, and if so, using what tools? > No debugging so far. But then I am not doing major modifications to the java code. My time is limited as well. I will try to upload what I do have later tonight. -- Rick Westerman wes...@pu... |
From: Erik V. <eri...@xs...> - 2010-02-10 23:07:01
|
A wiki would be a very good idea. I can't set it up, though. In general, to any kind of documentation I'm willing to contribute, answer questions, and/or review other people's contributions. But I don't want to own it. Erik. -----Original Message----- From: Stefan Frey [mailto:ste...@we...] Sent: Wednesday 10 February 2010 23:12 To: Development list for Rails: an 18xx game Subject: Re: [Rails-devel] Documentation I assume limited time is a common feature ;-) and most of the time the best reason for missing documentation... As I had to get myself familiar with the code and structure, I put down some notes already, which would need some polishing for others to understand. My take on doc is: The best and up-to-date documentation of the code is the code itself. Improving the code improves the documentation. Second best for code documenation is adding documentation in Javadoc comments. For higher-level documentation (for rails e.g. how to prepare XML files, design tiles, build the project, user documentation etc.) I prefer wikis for joint projects. Has anyone thought about setting up a wiki on sourceforge for Rails? Stefan On Wednesday 10 February 2010 22:48:59 Rick Westerman wrote: > > Care to collaborate on such documentation? I presume the audience is > > developers rather than users for now. > > Yes. Specifically for people who would want to add a new game to Rails > without having to do much extra coding. In other words perhaps a game > based on 1830 with parts from 1835 and 1870. Or something not too radical. > > > What do you like to improve? > > > > > > 2. Document the folder structure. > > Yes. This. Folder structure and what files are in the structure. > > I do not see a need to change the folder structure to "best practices". > Rather I am willing to work with it as it is. > > > PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to > > build stuff. However, I am also using eclipse for debugging. Do you use > > any debugging, and if so, using what tools? > > No debugging so far. But then I am not doing major modifications to the > java code. > > > My time is limited as well. I will try to upload what I do have later > tonight. ---------------------------------------------------------------------------- -- SOLARIS 10 is the OS for Data Centers - provides features such as DTrace, Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW http://p.sf.net/sfu/solaris-dev2dev _______________________________________________ Rails-devel mailing list Rai...@li... https://lists.sourceforge.net/lists/listinfo/rails-devel |
From: brett l. <wak...@gm...> - 2010-02-10 23:21:34
|
I can enable a wiki, if people are interested in using it. Secondary to that, I can start automatically generating the javadoc and uploading it to the website. I'll stick these on my todo list for (hopefully) this weekend. :-) ---Brett. On Wed, Feb 10, 2010 at 3:06 PM, Erik Vos <eri...@xs...> wrote: > A wiki would be a very good idea. I can't set it up, though. > In general, to any kind of documentation I'm willing to contribute, answer > questions, and/or review other people's contributions. > But I don't want to own it. > > Erik. > > -----Original Message----- > From: Stefan Frey [mailto:ste...@we...] > Sent: Wednesday 10 February 2010 23:12 > To: Development list for Rails: an 18xx game > Subject: Re: [Rails-devel] Documentation > > I assume limited time is a common feature ;-) and most of the time the best > > reason for missing documentation... > > As I had to get myself familiar with the code and structure, I put down some > > notes already, which would need some polishing for others to understand. > > My take on doc is: > The best and up-to-date documentation of the code is the code itself. > Improving the code improves the documentation. Second best for code > documenation is adding documentation in Javadoc comments. > > For higher-level documentation (for rails e.g. how to prepare XML files, > design tiles, build the project, user documentation etc.) I prefer wikis for > > joint projects. > Has anyone thought about setting up a wiki on sourceforge for Rails? > > Stefan > > On Wednesday 10 February 2010 22:48:59 Rick Westerman wrote: >> > Care to collaborate on such documentation? I presume the audience is >> > developers rather than users for now. >> >> Yes. Specifically for people who would want to add a new game to Rails >> without having to do much extra coding. In other words perhaps a game >> based on 1830 with parts from 1835 and 1870. Or something not too > radical. >> >> > What do you like to improve? >> > >> > >> > 2. Document the folder structure. >> >> Yes. This. Folder structure and what files are in the structure. >> >> I do not see a need to change the folder structure to "best practices". >> Rather I am willing to work with it as it is. >> >> > PS: Out of curiosity, I still use TextMate (a Mac editor) and ant to >> > build stuff. However, I am also using eclipse for debugging. Do you use >> > any debugging, and if so, using what tools? >> >> No debugging so far. But then I am not doing major modifications to the >> java code. >> >> >> My time is limited as well. I will try to upload what I do have later >> tonight. > > > > ---------------------------------------------------------------------------- > -- > SOLARIS 10 is the OS for Data Centers - provides features such as DTrace, > Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW > http://p.sf.net/sfu/solaris-dev2dev > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > > > ------------------------------------------------------------------------------ > SOLARIS 10 is the OS for Data Centers - provides features such as DTrace, > Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW > http://p.sf.net/sfu/solaris-dev2dev > _______________________________________________ > Rails-devel mailing list > Rai...@li... > https://lists.sourceforge.net/lists/listinfo/rails-devel > |
From: Rick W. <wes...@pu...> - 2010-02-11 01:00:39
|
On Feb 10, 2010, at 6:21 PM, brett lentz wrote: > I can enable a wiki, if people are interested in using it. We could try it. If it does not gain traction then we are no worse off. -- Rick |