Thanks everyone for the feedback so far!
In order to avoid unnecessary clutter, I've responded to `ruby-doc`
exclusively and added the respondents from ruby-talk cc.
James Britt <jbritt@xxxxxxxxxxxx>:
... The Pickaxe ... vaguely contentious ...
Pickaxe covers a great deal of relevant topics (rdoc, gems, packaging
c extensions), but I'm thinking of a slightly higher level. I'll sort
through it tonight.
I agree that these topics are highly contentious, but there's also a
number of things, everyone can agree on (e.g. tabs or spaces aren't as
important as consistency in general, it's ok to break rules, but not
for the sake of breaking the rules, packages should generally contain
a README file, etc.)
I want to gem up various parts I decided to go see how people
structure their gem dirs.
Remember any of the good ones?
Gavin Kistner <gavin.kistner@xxxxxxxxx>
Not specifically the feedback you might have been looking for, but I
give you a >hearty "awesome!" as my feedback.
Oh shucks, you made me blush... Concerning a directory template, if
that's all you need, that's sort of the current state of things, so
you might just want to grab a 0.0.0 version of the package :) It would
be nice to provide a project template generator tool as part of the
package which queries the user for project name, description,
preferences, etc. and then creates an "empty" project according to
your wishes.
There was a thread in ruby-talk ... about directory structures
There was a thread on directory structure recently, which concerned
namespaces mainly, which I hadn't thought of when I put together my
list of topics. I'll scan through them.
Gene Tani <gene.tani@xxxxxxxxx>
i haven't used this, but it's relevant enought to be not OT,
http://pycheesecake.org/
Cool, the python cheesecake project would definitely be cool for some
inspiration. It's kid of the inversion of what I'm thinking of, a
source code quality checker that checks the quality of the whole
package for "installibility" and documentation- and code quality. Not
sure if proper code quality metrics might be too controversial, maybe
`rcov` for test coverage...
John Gabriele <jmg3000@xxxxxxxxx> wrote:
I wouldn't worry about doing anything with "coding style", since
everyone has their own preferences.
That's what I was thinking as well.
I'd also add stuff about creating and uploading your site to rubyforge.
Also, you may want to go to your rubyforge admin page and:
1. Shut off the following items unless/until you decide you need them
I had no idea that was possible! Talk about reducing clutter!
2. Start a mailing list for the hello project.
done.
some particularly nice real-world projects t
These should be good examples to have a look at:
* rake
* rubygems
These two, along with rupport and camping were in fact the ones I got
started with!
* rmagick
I'll have a look. I guess it would be a good example for native extensions.
Thanks,
-tim
|