Commons Functor
  1. Commons Functor
  2. FUNCTOR-17

Move developers from @author tags to pom.xml

    Details

    • Type: Task Task
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 1.0
    • Fix Version/s: 1.0
    • Labels:

      Description

      [functor] codebase has many @author tags, but ASF board recommended removal of author tags[1] and other projects in Apache Commons have already removed them. We should remove them in [functor] too, before the first release.

      [1] http://osdir.com/ml/apache.community/2004-03/msg00048.html

        Activity

        Hide
        Simone Tripodi added a comment -

        fixed on r1345136

        all committers/contributors already credited in the pom.xml, so just removed @author tags

        Show
        Simone Tripodi added a comment - fixed on r1345136 all committers/contributors already credited in the pom.xml, so just removed @author tags
        Hide
        Bruno P. Kinoshita added a comment -

        Sorry, actually, both are already included under <contributors>, in the POM. So I believe we can proceed and remove the @author tags?

        Show
        Bruno P. Kinoshita added a comment - Sorry, actually, both are already included under <contributors>, in the POM. So I believe we can proceed and remove the @author tags?
        Hide
        Bruno P. Kinoshita added a comment -

        Sebb, indeed fine points. Agreed too, +1 for not automatically adding credit to every contributor.

        Matt,

        > we wouldn't want to obliterate an authorship credit that had previously stood (...)

        Good point too. Here's a list of contributors that used @author tags, but are not mentioned in the POM:

        • id=<empty>, name=Jason Horman, email=jason@jhorman.org
        • id=<empty>, name=Herve Quiroz, email=<empty>

        > (...) , but rather move it (to the POM).

        So, should someone talk to these authors and check if they would like to have their information included in the POM. before we remove the @author tags?

        FWIW, I've created a simple maven plugin (code at [1]) to help in this issue. It lists the authorship of a maven project. Here's the sample report produced (very basic) by this plugin http://www.tupilabs.com/commons-functor/authorship/index.html

        Thanks!

        [1] https://github.com/kinow/maven-authorship-plugin

        Show
        Bruno P. Kinoshita added a comment - Sebb, indeed fine points. Agreed too, +1 for not automatically adding credit to every contributor. Matt, > we wouldn't want to obliterate an authorship credit that had previously stood (...) Good point too. Here's a list of contributors that used @author tags, but are not mentioned in the POM: id=<empty>, name=Jason Horman, email=jason@jhorman.org id=<empty>, name=Herve Quiroz, email=<empty> > (...) , but rather move it (to the POM). So, should someone talk to these authors and check if they would like to have their information included in the POM. before we remove the @author tags? FWIW, I've created a simple maven plugin (code at [1] ) to help in this issue. It lists the authorship of a maven project. Here's the sample report produced (very basic) by this plugin http://www.tupilabs.com/commons-functor/authorship/index.html Thanks! [1] https://github.com/kinow/maven-authorship-plugin
        Hide
        Matt Benson added a comment -

        Fine points, Seb--as you describe, my meaning was more that we wouldn't want to obliterate an authorship credit that had previously stood, but rather move it (to the POM).

        Show
        Matt Benson added a comment - Fine points, Seb--as you describe, my meaning was more that we wouldn't want to obliterate an authorship credit that had previously stood, but rather move it (to the POM).
        Hide
        Sebb added a comment -

        There is a big difference between someone voluntarily adding their name to an @author tag in code and the id that SVN automatically adds to commit logs.

        Also, the proposal here is about removing the @author tags from the source code.
        Presumably the @author wants to be credited; therefore if we remove the tag, we should ensure that the contribution is credited elsewhere, e.g. the pom.xml. We are just moving the credit.

        If a committer wants to be credited other than in the SVN log, then it is up to them to add their name to the pom.xml.

        I think it is wrong to add people's names to the pom without an indication that they wish to be credited.
        For example, I have committed to many/most Commons components, but I don't wish to be credited in all the poms.

        I'd say it's more or less a requirement in that we want people to be credited for their contributions.

        My view is that we should not automatically credit every contributor; there should be some indication that they want credit. Not everyone does. But if they wish to be credited, then of course we should permit this.

        Show
        Sebb added a comment - There is a big difference between someone voluntarily adding their name to an @author tag in code and the id that SVN automatically adds to commit logs. Also, the proposal here is about removing the @author tags from the source code. Presumably the @author wants to be credited; therefore if we remove the tag, we should ensure that the contribution is credited elsewhere, e.g. the pom.xml. We are just moving the credit. If a committer wants to be credited other than in the SVN log, then it is up to them to add their name to the pom.xml. I think it is wrong to add people's names to the pom without an indication that they wish to be credited. For example, I have committed to many/most Commons components, but I don't wish to be credited in all the poms. I'd say it's more or less a requirement in that we want people to be credited for their contributions. My view is that we should not automatically credit every contributor; there should be some indication that they want credit. Not everyone does. But if they wish to be credited, then of course we should permit this.
        Hide
        Matt Benson added a comment -

        I'd say it's more or less a requirement in that we want people to be credited for their contributions.

        Show
        Matt Benson added a comment - I'd say it's more or less a requirement in that we want people to be credited for their contributions.
        Hide
        Bruno P. Kinoshita added a comment -

        +1 Sebb, is there a requirement to have all the authors from the commit log present in the pom.xml authors section?

        Show
        Bruno P. Kinoshita added a comment - +1 Sebb, is there a requirement to have all the authors from the commit log present in the pom.xml authors section?
        Hide
        Sebb added a comment -

        Rather than just removing them, the authors can be credited in the pom developer section

        Show
        Sebb added a comment - Rather than just removing them, the authors can be credited in the pom developer section

          People

          • Assignee:
            Simone Tripodi
            Reporter:
            Bruno P. Kinoshita
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development