[Nitro] New implementation of Og Validations. (Help needed)

James Britt james.britt at gmail.com
Thu Mar 8 15:45:20 EST 2007


George Moschovitis wrote:

> This is supposed to be a public project, so some input AND help from
> the community is required. An additional validation spec would be
> quite nice to have.

Is there a document that clearly explains the steps needed to contribute?

* How to get the current source
  - How to get and install darcs if you don't already have it

* How the source code is structured

* How to run the current code without unwanted interference from 
currently installed Nitro/Og libs

* How to write comments

* Coding style

* How to create a patch
- specific commands
- How to write change log comments

* How to submit a patch

* Current issues that are more probably deserving of attention than others


The folks on the ruby-doc list have been helping  to assemble a document 
like this for the documentation of the base Ruby code.  There are people 
who want to help improve the Ruby docs, but they don't know where to 
begin or what, exactly, to do.  The easier it is for such people, the 
more they'll want to do, and the more will get done.


I set up a document describing the process on Google docs, and shared 
with  a few people who were interested in helping to edit it.  I then 
set up a cron task on ruby-doc.org to fetch the page every so often and 
republish it on ruby-doc.org.  (It's hackish but it was fairly easy to 
do; if I had to think about a more elegant solution I would never have 
gotten around to it.)

The best part is that someone has stepped up to help really fix up that 
document; a great example of bootstrapping community involvement.



-- 
James Britt

"Hackers will be expelled"
  -  The Breakfast Club (1985)


More information about the Nitro-general mailing list