[Owasp-orizon] Source file credits naming convention..

[Stephen Craig Evans]

Yes, that's fine with me.

Stephen

On Wed, Feb 25, 2009 at 1:33 AM, Paolo Perego <thesp0nge at owasp.org> wrote:
> Hi List, we're growing and I'm really happy about it.
> Before going further I want to discuss you a naming convention to be
> used to give proper credits for people working over orizon sources...
>
> I propose to use linux sources as example. They write on top of each
> file the following:
>
> ---
> filename - oneline description
> (C) year the first one working on that file
>
> GPL license
> ---
>
>
> We can use the same approach with just a minor tweak. We'll give the
> first credit to the first one working on that file, but we'll write a
> Changelog in the comment.
> At the end of the preamble block, we need to write javadoc @author
> keyword, so each file author if more than one will
> have a single @author keyword at the end of the credit block.
>
> eg.
>
> /**
> PhpCollector - the collector for PHP
> (C) 2008-2009 thesp0nge
>
> GPL v3 license
>
> Changelog:
> 20090212: major cleanup and implementation of foo() and bar(), Stephen
> <step at email>
>
> @author thesp0nge
> @author stephen
> @author someother
> */
>
> What do you think about it? Do you think is a fair way to manage credits?
> If not, please let me now your opinion :)
>
> Paolo
> --
> "stay hungry, stay foolish"
>
> OWASP Orizon project, http://orizon.sourceforge.net
> "enjoy your code review experience"
> _______________________________________________
> Owasp-orizon mailing list
> Owasp-orizon at lists.owasp.org
> https://lists.owasp.org/mailman/listinfo/owasp-orizon
>



-- 
http://www.linkedin.com/in/stephencraigevans