Skip to content
This repository has been archived by the owner on Dec 7, 2022. It is now read-only.

Remove AUTHORS #3393

Merged
merged 1 commit into from Apr 5, 2018
Merged

Remove AUTHORS #3393

merged 1 commit into from Apr 5, 2018

Conversation

alexxa
Copy link
Contributor

@alexxa alexxa commented Mar 23, 2018

Please consider removing AUTHORS file.

  • One can find all contributors in Contributors.
  • There are Git commands to grep a list of all contributors, e.g. git shortlog -sne. It displays a sum of all commits+names+emails, the same as AUTHORS currently.

^^ Therefore, reasoning "That way you can prove to all your friends that you contributed to Pulp!" doesn't make much sense.

  • Hardcoding AUTHORS requires an extra effort and maintenance. Currently, AUTHORS file is outdated. Not all contributors are listed there.
  • Some people don't like to share their personal and working emails that way and somebody can use it. Recently, I have received several emails from HRs saying they found my name and contact details in that file.

@pulpbot
Copy link
Member

pulpbot commented Mar 23, 2018

Can one of the admins verify this patch?

@dralley
Copy link
Contributor

dralley commented Apr 2, 2018

@alexxa

I don't expect we will remove the entire file, but if you update this PR to remove only your name from the file, we would gladly do that.

git shortlog -sne is not a perfect solution because some people have duplicate entries, due to having their git config email set to different addresses (or misconfigured) at different points in time. e.g:

   318	Mike McCune <mmccune@redhat.com>
    11	Mike McCune <mmccune@gmail.com>
    10	Mike McCune <mmccune@gibson.pdx.redhat.com>
     4	Mike McCune <mmccune@localhost.localdomain>
   327	Brian Bouterse <bmbouter@gmail.com>
   114	bmbouter <bmbouter@gmail.com>
   107	bmbouter <bmbouter@redhat.com>
     3	Brian Bouterse <bmbouter@dhcp129-70.rdu.redhat.com>
   270	Jeremy Cline <jcline@redhat.com>
   143	Jeremy Cline <jeremy@jcline.org>
    30	Jeremy Cline <einecline@gmail.com>
     7	Jeremy Cline <jrcline2@ncsu.edu>

@bmbouter
Copy link
Member

bmbouter commented Apr 2, 2018

If you can see any ways the AUTHORS can be improved (without deleting it) that would be good. Maybe auditing that the git log and the AUTHORS file are in sync? Just an idea I wanted to share.

@alexxa
Copy link
Contributor Author

alexxa commented Apr 3, 2018

Hello,

@dralley,

True, there are several entries per one name. True, it can be because one uses several email addresses or it is misconfigured . However,

  • In our world, names are not unique. There can be at least two persons sharing the same name and contributing to Pulp. But those two will never have the same email address.

  • People can change their emails and even names. For example, one leaves RH. Do you suggest to update the AUTHORS file every time it happens? I doubt one did/will do it.

Therefore git shortlog -sne showing contributors by email entry and not squashing them by name is completely logical.

@bmbouter, Still, I don't consider it's reasonable to keep the AUTHORS file, especially by adding some scripts, which will be triggered by every new PR.

I know Katello guys had/have it, since their CONTRIBUTORS file has 'duplicate' entries. But if one looks at the date it was updated the last time (July'15) and names in commits history, it seems they don't use it anymore.

BTW, not every repo in Pulp GItOrg has AUTHORS file. And those, which do, are outdated too.

Guys, ... AUTHORS file is kind of old-fashion thing, when Git didn't have means to list contributors. It was essential when the project was tend to be migrated from other versioning system... and if there are any contributors sending their patches by e-mail. If the project is intended to be kept in git and all contributors will use git to contribute, it's just redundant relict of the past era of early open source communities.

Let me know if it's still not convincing, I'm cool to update this PR and remove my name only.

--alexxa

@daviddavis
Copy link
Contributor

👍 from me.

@daviddavis
Copy link
Contributor

daviddavis commented Apr 3, 2018

@alexxa would you mind starting a discussion on our mailing list?

https://www.redhat.com/mailman/listinfo/pulp-dev

Just want to discuss this with the entire community. If you cannot, I'll handle it. Thanks!

@alexxa
Copy link
Contributor Author

alexxa commented Apr 4, 2018

Thanks for the support, @daviddavis. Ok, I will do it.

@bmbouter
Copy link
Member

bmbouter commented Apr 4, 2018

@alexxa Can the docs be updated for this change? Like references about AUTHORS on this page. Also can the AUTHORS file be kept but have it's contents replaced with some simple text recommending the user to use git shortlog -sne command.

What do you think about ^ ideas?
Also note that the source tree of Pulp3 is fully branched and will never merge again so if possible could the exact same thing be also done in a separate PR against pulp/pulp:3.0-dev?

Thank you for this idea, communication, and code!

@dralley
Copy link
Contributor

dralley commented Apr 4, 2018

I would rather get rid of the AUTHORS entirely and put the documentation for git shortlog -sne elsewhere (or nowhere).

People who want that info should just look at the contributors page for the repository on github and, if they need the list in text form, git shortlog -sn is very very high in the search rankings for that query.

@alexxa alexxa mentioned this pull request Apr 5, 2018
@alexxa
Copy link
Contributor Author

alexxa commented Apr 5, 2018

@bmbouter I have just opened a similar PR against 3.0-dev, #3410 . Let me know if I should do anything else, please.

@bmbouter
Copy link
Member

bmbouter commented Apr 5, 2018

Thanks @alexxa I'm going to go ahead and merge.

@bmbouter bmbouter merged commit 13c49cd into pulp:master Apr 5, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
5 participants