<html><head><style type="text/css"><!-- DIV {margin:0px;} --></style></head><body><div style="font-family:times new roman,new york,times,serif;font-size:12pt"><div style="font-family: times new roman,new york,times,serif; font-size: 12pt;"><span style="font-weight: bold;">-1<br></span>It is optional - would be better to allow keeping authors tags while automating process of getting full list.<br><br>On one hand, I'm not sold on the idea that if the author tag will be removed it might help to brought more commiters. If I see some issue in the source code and I know how to fix it - I'll provide a patch/fix whetever I'm in the "magic list" or not. <br><br>The only question that might be asked: are OSS team members interested in accepting such contributor's efforts or not? <br>It's about mentality and maturity of committers as well as part of OSS
project's culture established by team members - e.g. responding to
user questions, issues, etc - in e-mails, users forums, etc and welcoming user's opinions on how things should work (functional requirements). Also you can use something like following: "@author DNA Expert Group"
for classes/packages designed / developed by group of authors.<br><br>Generally, I believe that everything that is part of Java Language specification (e.g.) and/or part of general practices is valid and justified to be part of any source code.<br><br>On the other hand, since <span style="font-weight: bold;">it's possible to automate process of getting list of autors from both - SCM repository and source code/POM - maintenance would not be that hard</span>, and IMO efforts should go that way rather than removing tags. I bet that I can find some maven plugin or develop my own to automate that process. For example, http://www.statsvn.org and http://stat-scm.sourceforge.net are good starting points. <br><br><span style="font-weight: bold;">I will vote "+2" on the ability to automate process of getting full list of contributors (maven report plugin) and makit it part of distribution and Maven project site</span>.<br><br>Sergiy<br> <br><div
style="font-family: arial,helvetica,sans-serif; font-size: 13px;"><font size="2" face="Tahoma"><hr size="1"><b><span style="font-weight: bold;">From:</span></b> "dna-dev-request@lists.jboss.org" <dna-dev-request@lists.jboss.org><br><b><span style="font-weight: bold;">To:</span></b> dna-dev@lists.jboss.org<br><b><span style="font-weight: bold;">Sent:</span></b> Wednesday, 14 January, 2009 6:43:27 PM<br><b><span style="font-weight: bold;">Subject:</span></b> dna-dev Digest, Vol 10, Issue 5<br></font><br>Send dna-dev mailing list submissions to<br> <a ymailto="mailto:dna-dev@lists.jboss.org" href="mailto:dna-dev@lists.jboss.org">dna-dev@lists.jboss.org</a><br><br>To subscribe or unsubscribe via the World Wide Web, visit<br> <a href="https://lists.jboss.org/mailman/listinfo/dna-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/dna-dev</a><br>or, via email, send a message with subject or body 'help'
to<br> <a ymailto="mailto:dna-dev-request@lists.jboss.org" href="mailto:dna-dev-request@lists.jboss.org">dna-dev-request@lists.jboss.org</a><br><br>You can reach the person managing the list at<br> <a ymailto="mailto:dna-dev-owner@lists.jboss.org" href="mailto:dna-dev-owner@lists.jboss.org">dna-dev-owner@lists.jboss.org</a><br><br>When replying, please edit your Subject line so it is more specific<br>than "Re: Contents of dna-dev digest..."<br><br><br>Today's Topics:<br><br> 1. Re: @author tags in our codebase (Randall Hauch)<br> 2. Re: @author tags in our codebase (Vatsal)<br><br><br>----------------------------------------------------------------------<br><br>Message: 1<br>Date: Tue, 13 Jan 2009 16:03:23 -0600<br>From: Randall Hauch <<a ymailto="mailto:rhauch@redhat.com" href="mailto:rhauch@redhat.com">rhauch@redhat.com</a>><br>Subject: Re: [dna-dev] @author tags in our codebase<br>To: JBoss DNA
<<a ymailto="mailto:dna-dev@lists.jboss.org" href="mailto:dna-dev@lists.jboss.org">dna-dev@lists.jboss.org</a>><br>Message-ID: <<a ymailto="mailto:160467FE-4D64-4943-BBAC-3D9535FD670C@redhat.com" href="mailto:160467FE-4D64-4943-BBAC-3D9535FD670C@redhat.com">160467FE-4D64-4943-BBAC-3D9535FD670C@redhat.com</a>><br>Content-Type: text/plain; charset="us-ascii"<br><br>We never really came to a consensus on this question, and I'd like to <br>try to do that. To be clear, here is the proposal:<br><br>1) Remove the @author lines from the code, and instead rely upon SVN <br>as the official master record of individual contributions<br>2) Change the Eclipse preference files to remove the @author lines <br>from the code templates<br>3) Add a AUTHORS file to the distribution(s); this file will contain <br>the names and email addresses for all contributors, and can even allow <br>a contributor to describe their
contribution if they so desire.<br>4) Change the headers to remove the "@author" wording and to replace <br>it with "See the AUTHORS file in the<br>distribution for a full listing of individual contributors."<br>5) Change the POM files to include the AUTHORS file in each <br>distribution.<br><br>The AUTHORS file would look like this:<br><br>Randall Hauch (<a ymailto="mailto:rhauch@redhat.com" href="mailto:rhauch@redhat.com">rhauch@redhat.com</a>)<br>John Verhaeg (<a ymailto="mailto:jverhaeg@redhat.com" href="mailto:jverhaeg@redhat.com">jverhaeg@redhat.com</a>)<br>Dan Florian (<a ymailto="mailto:dflorian@redhat.com" href="mailto:dflorian@redhat.com">dflorian@redhat.com</a>)<br>Stefano Maestri (<a ymailto="mailto:stefano.maestri@javalinux.it" href="mailto:stefano.maestri@javalinux.it">stefano.maestri@javalinux.it</a>)<br>Serge Pagop (<a ymailto="mailto:Serge.Pagop@innoq.com"
href="mailto:Serge.Pagop@innoq.com">Serge.Pagop@innoq.com</a>)<br>Michael Trezzi (<a ymailto="mailto:michael@mathwizard.org" href="mailto:michael@mathwizard.org">michael@mathwizard.org</a>)<br>Alexandre Porcelli (<a ymailto="mailto:porcelli@devexp.com.br" href="mailto:porcelli@devexp.com.br">porcelli@devexp.com.br</a>)<br>Sergiy Litsenko (<a ymailto="mailto:litsenko_sergey@yahoo.com" href="mailto:litsenko_sergey@yahoo.com">litsenko_sergey@yahoo.com</a>)<br><br>Note that unlike the @author tags, this file will list all <br>contributors, and the names of new contributors will be appended to <br>the list by the project lead. (No names will be removed from this <br>file.)<br><br>I would prefer to hear from every contributor, so please respond with <br>+1 if you agree with this proposal, 0 if you don't care, or -1 if you <br>want to keep the @author tags. If you vehemently want to keep the <br>@author tags and
names in the source file, please say so.<br><br>Best regards,<br><br>Randall<br><br>On Nov 18, 2008, at 3:33 PM, Randall Hauch wrote:<br><br>><br>> On Nov 18, 2008, at 2:52 PM, Stefano Maestri wrote:<br>><br>>><br>>> Randall Hauch wrote on 17/11/08 22:17:<br>>>> I've recently read a suggestions for open source communities that <br>>>> the<br>>>> author names are removed from the content. In the case of DNA's<br>>>> codebase, that would mean removing the @author tags.<br>>> May I ask where?<br>><br>> I knew someone was going to ask. :-) I had to go back and look, but <br>> here are a few:<br>> <a href="http://video.google.com/videoplay?docid=-4216011961522818645&ei=8o0YSbiFOY6qrgLC2PnLDQ&q=poisonous+people" target="_blank">http://video.google.com/videoplay?docid=-4216011961522818645&ei=8o0YSbiFOY6qrgLC2PnLDQ&q=poisonous+people</a><br>> <a
href="http://docs.ofbiz.org/display/OFBADMIN/Coding+Conventions" target="_blank">http://docs.ofbiz.org/display/OFBADMIN/Coding+Conventions</a><br>> <a href="http://subversion.tigris.org/hacking.html#other-conventions" target="_blank">http://subversion.tigris.org/hacking.html#other-conventions</a><br>> <a href="http://blogs.sun.com/ahe/entry/author_tags" target="_blank">http://blogs.sun.com/ahe/entry/author_tags</a><br>><br>>><br>>>><br>>>> tags:<br>>>><br>>>> 1. When there are no @author tags, then there is a far smaller<br>>>> notion of ownership by the author(s). On one side of this, the<br>>>> author(s) may not appreciate changes to "their" code, and on the<br>>>> other side, non-authors may feel intimidated about working on<br>>>> code for which they are not an author. IMO, we want
to<br>>>> _discourage_ ownership and _encourage_ everyone to work in any<br>>>> area of the code they want.<br>>>><br>>> +1...but is really @author tag intimating someone, or giving <br>>> ownership<br>>> to some other? Quiet frankly not for me.<br>><br>> I hope it doesn't discourage people from contributing and diving in <br>> wherever they want. BTW, it's quite possible that no matter what <br>> our policy, some people may not like it. For example, if we were to <br>> adopt a policy of NOT including @author tags, some people may refuse <br>> to join the community because they see the @author tag as proof they <br>> worked on it. It takes all kinds of people. :-)<br>><br>>><br>>> Anyway I agree on the _discurage_ownership and _encourage_everyone to<br>>> work in any area, so if it can
help, remove @author tag.<br>>><br>>>> 1. @author tags can be inaccurate. SVN has the true history of who<br>>>> contributed exactly what code.<br>>>><br>>> +1<br>><br>> IMO, this is perhaps the biggest justifiable reason. Its rubbish if <br>> its not up-to-date, so it seems far better to not have @author tags.<br>><br>>><br>>>><br>>>> The only benefit I can think of is that the @author tag does help to<br>>>> give some notion of who is the "expert" of the class, in case they<br>>>> need to be consulted. However, I don't believe this is really <br>>>> much of<br>>>> a reason, since it's far better to consult the SVN history and see <br>>>> who<br>>>> actually modified the different parts of the code. In fact, the<br>>>> annotated views in Fisheye even show
on many of the lines the name <br>>>> of<br>>>> the last person to change it. For example,<br>>>> see <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-common/src/main/java/org/jboss/dna/common/i18n/I18n.java?r=120" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-common/src/main/java/org/jboss/dna/common/i18n/I18n.java?r=120</a><br>>>><br>>> abosolutely better to use fisheye...if fine people of JBoss.org would<br>>> also mind to upgrade it to a more recent version it would be even<br>>> better. Also Jira integration may help a lot.<br>>><br>>> I would just add that if we decide to remove the tag we have to <br>>> change<br>>> also the license information at the beginnig of any file which say:<br>>> /* 2<br>>> <<a
href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l2" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l2</a> <br>>> ><br>>> * JBoss, Home of Professional Open Source. 3<br>>> <<a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l3" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l3</a> <br>>> ><br>>> * Copyright 2008, Red Hat Middleware LLC, and individual <br>>> contributors 4<br>>> <<a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l4"
target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l4</a> <br>>> ><br>>> * as indicated by the @author tags. See the copyright.txt file in <br>>> the 5<br>>> <<a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l5" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l5</a> <br>>> ><br>>> * distribution for a full listing of individual contributors.<br>>><br>><br>> Yes, we'd have to update the headers.<br>><br>> Best regards,<br>><br>> Randall<br>><br><br>-------------- next part --------------<br>An HTML attachment was scrubbed...<br>URL: <a href="http://lists.jboss.org/pipermail/dna-dev/attachments/20090113/d2486bd9/attachment-0001.html"
target="_blank">http://lists.jboss.org/pipermail/dna-dev/attachments/20090113/d2486bd9/attachment-0001.html</a><br><br>------------------------------<br><br>Message: 2<br>Date: Wed, 14 Jan 2009 13:13:23 +0530<br>From: Vatsal <<a ymailto="mailto:vatsal.avasthi@gmail.com" href="mailto:vatsal.avasthi@gmail.com">vatsal.avasthi@gmail.com</a>><br>Subject: Re: [dna-dev] @author tags in our codebase<br>To: <a ymailto="mailto:dna-dev@lists.jboss.org" href="mailto:dna-dev@lists.jboss.org">dna-dev@lists.jboss.org</a><br>Message-ID:<br> <<a ymailto="mailto:c82836c60901132343w54b690a9ha9c183e5ee61d019@mail.gmail.com" href="mailto:c82836c60901132343w54b690a9ha9c183e5ee61d019@mail.gmail.com">c82836c60901132343w54b690a9ha9c183e5ee61d019@mail.gmail.com</a>><br>Content-Type: text/plain; charset="iso-8859-1"<br><br>Sometimes it is fun to see your name in author tag of a project at a later<br>date when the project has matured but my vote would
be for Randall's<br>suggestions due to practical & maintenance reasons discussed earlier, so a<br>+1 from me for this proposal(though I am not a contributor yet :) )...<br>- Vatsal<br><br>On Wed, Jan 14, 2009 at 3:33 AM, Randall Hauch <<a ymailto="mailto:rhauch@redhat.com" href="mailto:rhauch@redhat.com">rhauch@redhat.com</a>> wrote:<br><br>> We never really came to a consensus on this question, and I'd like to try<br>> to do that. To be clear, here is the proposal:<br>><br>> 1) Remove the @author lines from the code, and instead rely upon SVN as the<br>> official master record of individual contributions<br>> 2) Change the Eclipse preference files to remove the @author lines from the<br>> code templates<br>> 3) Add a AUTHORS file to the distribution(s); this file will contain the<br>> names and email addresses for all contributors, and can even allow a<br>> contributor to describe their contribution if they
so desire.<br>> 4) Change the headers to remove the "@author" wording and to replace it<br>> with "See the AUTHORS file in the<br>> distribution for a full listing of individual contributors."<br>> 5) Change the POM files to include the AUTHORS file in each distribution.<br>><br>> The AUTHORS file would look like this:<br>><br>> Randall Hauch (<a ymailto="mailto:rhauch@redhat.com" href="mailto:rhauch@redhat.com">rhauch@redhat.com</a>)<br>><br>> John Verhaeg (<a ymailto="mailto:jverhaeg@redhat.com" href="mailto:jverhaeg@redhat.com">jverhaeg@redhat.com</a>)<br>> Dan Florian (<a ymailto="mailto:dflorian@redhat.com" href="mailto:dflorian@redhat.com">dflorian@redhat.com</a>)<br>> Stefano Maestri (<a ymailto="mailto:stefano.maestri@javalinux.it" href="mailto:stefano.maestri@javalinux.it">stefano.maestri@javalinux.it</a>)<br>> Serge Pagop (<a ymailto="mailto:Serge.Pagop@innoq.com"
href="mailto:Serge.Pagop@innoq.com">Serge.Pagop@innoq.com</a>)<br>> Michael Trezzi (<a ymailto="mailto:michael@mathwizard.org" href="mailto:michael@mathwizard.org">michael@mathwizard.org</a>)<br>> Alexandre Porcelli (<a ymailto="mailto:porcelli@devexp.com.br" href="mailto:porcelli@devexp.com.br">porcelli@devexp.com.br</a>)<br>> Sergiy Litsenko (<a ymailto="mailto:litsenko_sergey@yahoo.com" href="mailto:litsenko_sergey@yahoo.com">litsenko_sergey@yahoo.com</a>)<br>><br>><br>> Note that unlike the @author tags, this file will list all contributors,<br>> and the names of new contributors will be appended to the list by the<br>> project lead. (No names will be removed from this file.)<br>><br>> I would prefer to hear from every contributor, so please respond with +1 if<br>> you agree with this proposal, 0 if you don't care, or -1 if you want to keep<br>> the @author tags. If you vehemently want to keep the
@author tags and names<br>> in the source file, please say so.<br>><br>> Best regards,<br>><br>> Randall<br>><br>> On Nov 18, 2008, at 3:33 PM, Randall Hauch wrote:<br>><br>><br>> On Nov 18, 2008, at 2:52 PM, Stefano Maestri wrote:<br>><br>><br>> Randall Hauch wrote on 17/11/08 22:17:<br>><br>> I've recently read a suggestions for open source communities that the<br>><br>> author names are removed from the content. In the case of DNA's<br>><br>> codebase, that would mean removing the @author tags.<br>><br>> May I ask where?<br>><br>><br>> I knew someone was going to ask. :-) I had to go back and look, but here<br>> are a few:<br>><br>> <a href="http://video.google.com/videoplay?docid=-4216011961522818645&ei=8o0YSbiFOY6qrgLC2PnLDQ&q=poisonous+people"
target="_blank">http://video.google.com/videoplay?docid=-4216011961522818645&ei=8o0YSbiFOY6qrgLC2PnLDQ&q=poisonous+people</a><br>> <a href="http://docs.ofbiz.org/display/OFBADMIN/Coding+Conventions" target="_blank">http://docs.ofbiz.org/display/OFBADMIN/Coding+Conventions</a><br>> <a href="http://subversion.tigris.org/hacking.html#other-conventions" target="_blank">http://subversion.tigris.org/hacking.html#other-conventions</a><br>> <a href="http://blogs.sun.com/ahe/entry/author_tags" target="_blank">http://blogs.sun.com/ahe/entry/author_tags</a><br>><br>><br>><br>> tags:<br>><br>><br>> 1. When there are no @author tags, then there is a far smaller<br>><br>> notion of ownership by the author(s). On one side of this, the<br>><br>> author(s) may not appreciate changes to "their" code, and on the<br>><br>> other side, non-authors may feel
intimidated about working on<br>><br>> code for which they are not an author. IMO, we want to<br>><br>> _discourage_ ownership and _encourage_ everyone to work in any<br>><br>> area of the code they want.<br>><br>><br>> +1...but is really @author tag intimating someone, or giving ownership<br>><br>> to some other? Quiet frankly not for me.<br>><br>><br>> I hope it doesn't discourage people from contributing and diving in<br>> wherever they want. BTW, it's quite possible that no matter what our<br>> policy, some people may not like it. For example, if we were to adopt a<br>> policy of NOT including @author tags, some people may refuse to join the<br>> community because they see the @author tag as proof they worked on it. It<br>> takes all kinds of people. :-)<br>><br>><br>> Anyway I agree on the _discurage_ownership and
_encourage_everyone to<br>><br>> work in any area, so if it can help, remove @author tag.<br>><br>><br>> 1. @author tags can be inaccurate. SVN has the true history of who<br>><br>> contributed exactly what code.<br>><br>><br>> +1<br>><br>><br>> IMO, this is perhaps the biggest justifiable reason. Its rubbish if its<br>> not up-to-date, so it seems far better to not have @author tags.<br>><br>><br>><br>> The only benefit I can think of is that the @author tag does help to<br>><br>> give some notion of who is the "expert" of the class, in case they<br>><br>> need to be consulted. However, I don't believe this is really much of<br>><br>> a reason, since it's far better to consult the SVN history and see who<br>><br>> actually modified the different parts of the code. In fact, the<br>><br>> annotated views in Fisheye even show on
many of the lines the name of<br>><br>> the last person to change it. For example,<br>><br>> see<br>> <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-common/src/main/java/org/jboss/dna/common/i18n/I18n.java?r=120" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-common/src/main/java/org/jboss/dna/common/i18n/I18n.java?r=120</a><br>><br>><br>> abosolutely better to use fisheye...if fine people of JBoss.org would<br>><br>> also mind to upgrade it to a more recent version it would be even<br>><br>> better. Also Jira integration may help a lot.<br>><br>><br>> I would just add that if we decide to remove the tag we have to change<br>><br>> also the license information at the beginnig of any file which say:<br>><br>> /* 2<br>><br>> <<br>> <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l2"
target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l2</a><br>> ><br>><br>> * JBoss, Home of Professional Open Source. 3<br>><br>> <<br>> <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l3" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l3</a><br>> ><br>><br>> * Copyright 2008, Red Hat Middleware LLC, and individual contributors 4<br>><br>> <<br>> <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l4" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l4</a><br>> ><br>><br>> * as indicated by the @author tags. See the copyright.txt file in the
5<br>><br>> <<br>> <a href="http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l5" target="_blank">http://fisheye.jboss.org/browse/DNA/trunk/dna-graph/src/main/java/org/jboss/dna/graph/GraphI18n.java?r=598#l5</a><br>> ><br>><br>> * distribution for a full listing of individual contributors.<br>><br>><br>><br>> Yes, we'd have to update the headers.<br>><br>> Best regards,<br>><br>> Randall<br>><br>><br>><br>> _______________________________________________<br>> dna-dev mailing list<br>> <a ymailto="mailto:dna-dev@lists.jboss.org" href="mailto:dna-dev@lists.jboss.org">dna-dev@lists.jboss.org</a><br>> <a href="https://lists.jboss.org/mailman/listinfo/dna-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/dna-dev</a><br>><br>><br>-------------- next part --------------<br>An HTML attachment was scrubbed...<br>URL: <a
href="http://lists.jboss.org/pipermail/dna-dev/attachments/20090114/4b648c37/attachment.html" target="_blank">http://lists.jboss.org/pipermail/dna-dev/attachments/20090114/4b648c37/attachment.html</a><br><br>------------------------------<br><br>_______________________________________________<br>dna-dev mailing list<br><a ymailto="mailto:dna-dev@lists.jboss.org" href="mailto:dna-dev@lists.jboss.org">dna-dev@lists.jboss.org</a><br><a href="https://lists.jboss.org/mailman/listinfo/dna-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/dna-dev</a><br><br><br>End of dna-dev Digest, Vol 10, Issue 5<br>**************************************<br></div></div></div><br>
<hr size=1>
Stay connected to the people that matter most with a smarter inbox. <a href="http://au.rd.yahoo.com/galaxy/mail/tagline2/*http://au.docs.yahoo.com/mail/smarterinbox" target=_blank>Take a look</a>.</body></html>