[sldev] Good patch practice

Ettore Pasquini ettore_pasquini at 3dconnexion.com
Thu May 31 16:17:44 PDT 2007


On 5/31/07 4:00 PM, "Jason Giglio" <gigstaggart at gmail.com> wrote:

> "Please do not add issue numbers or your name to patches. We have to
> remove these by hand. "
> 
> I'm not clear on this part.  Do you not want us to name the patch file
> with our name?   Or not put our name in comments?

I think Rob said to put our names only in the doc/contributions.txt file,
which seems a clean and reasonable idea to me.

> I think it's pretty
> important to put our name (or initials or whatever) in comments, so
> people know who to call if they have a question about why that part of
> the code is doing something weird.

If that part of the code is doing something weird it could very well be for
other reasons (i.e. side effects of other code). So it doesn't really
provide any relevant information to have a name in the comments. I always
deeply hated that.

> Linden Lab devs sign their comments, why would we do something different?

You're right on this one - we all should do the same! :)

I think having code without people names, patch references, bug numbers and
what not is aimed to have a clean code-base without junk. Comments *are*
part of the code in my opinion, so they should be carefully written, just as
the executable code.

Ettore



More information about the SLDev mailing list