Trac Etiquitte/Preferred Practice

1 view
Skip to first unread message

jamie...@gmail.com

unread,
Jan 21, 2007, 11:23:35 PM1/21/07
to Ruby on Rails: Core
An issue came up today with some recent "tiny" documentation patches I
submitted and I was hoping to get some feedback from the core team
about what the right thing to do was.

Basically, I have been going through the documentation checking for
RDoc formatting errors with the docs, places where either +'s or <tt>
tags were used in a way that causes the documentation to not display as
expected. For each file I came across with this problem I submitted a
new ticket labeled [PATCH][DOCS][TINY] along with a .diff patch for the
issue (Following Josh Susser's ever popular "Laying Tracks"
presentation).

What is preferred practice in this case? Would the core team usually
prefer to have a single patch for all these fixes, one for all the
issues from each part of Rails (the files with documentation issues
spanned multiple parts: ActiveRecord, ActiveSupport, RailTies etc.), or
is submitting single patches in this instance OK?

I'm just asking because I've been publicly accused of bad etiquette (I
apologize if this is so) and would like to know how to do it right in
the future.

Best,
Jamie

Michael Koziarski

unread,
Jan 21, 2007, 11:34:36 PM1/21/07
to rubyonra...@googlegroups.com
> What is preferred practice in this case? Would the core team usually
> prefer to have a single patch for all these fixes, one for all the
> issues from each part of Rails (the files with documentation issues
> spanned multiple parts: ActiveRecord, ActiveSupport, RailTies etc.), or
> is submitting single patches in this instance OK?

It's a judgement call really. One massive patch which fixes 999999
tiny little things is just as bad as a whole patch for a 1 char
change. With the current score-keeping taking place, I'd err on the
side of patches which are too large, lest one be accused of
artificially driving up one's score.

--
Cheers

Koz

Reply all
Reply to author
Forward
0 new messages