Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Remove AUTHORS.txt (or make it up-to-date) #1807

Closed
jku opened this issue Jan 28, 2022 · 4 comments · Fixed by #1871
Closed

docs: Remove AUTHORS.txt (or make it up-to-date) #1807

jku opened this issue Jan 28, 2022 · 4 comments · Fixed by #1871
Assignees
Labels
documentation Documentation of the project as well as procedural documentation

Comments

@jku
Copy link
Member

jku commented Jan 28, 2022

The intent to credit contributors is admirable but the file is outdated and does not really give us a lot of value over git shortlog -s. I also do not think the file helps in tracking authorship since the file provides no information about what people authored.

Admittedly the file is better formatted than shortlog output... but if the file is not up to date then that does not help.

@jku jku added the documentation Documentation of the project as well as procedural documentation label Jan 28, 2022
@lukpueh
Copy link
Member

lukpueh commented Feb 3, 2022

AUTHORS.txt (and the acknowledgement section in the main README) has a few names that aren't in git shortlog, because

  • their involvement predates the use of git for python-tuf development, or
  • they contributed to a TUF subproject other than python-tuf (e.g. notary, etc.)

I suggest to

  1. update the acknowledgement section in README.md (or replace it with a dedicated acknowledgements document) that lists all significant and no longer active contributors and maintainers of python-tuf, which we should keep up-to-date (see Yearly maintainer list cleanup #1793), optionally with their organization affiliation
  2. maybe do something similar for the TUF organization (for the lack of a theupdateframework/community repo, it could be part of theupdateframework.io),
  3. remove AUTHORS.txt in this repo

@lukpueh
Copy link
Member

lukpueh commented Feb 15, 2022

@JustinCappos, would you mind weighing in on what to do with the AUTHORS.txt document?

@JustinCappos
Copy link
Member

I am in favor of the approach you suggest @lukpueh . Does anyone object?

@joshuagl
Copy link
Member

No objections.

From an implementation perspective, reproducible-builds.org contributor page lists everyone who touched the repo plus explicitly named personnel. We might create a similar script for listing TUF contributors on theupdateframework.io? See https://salsa.debian.org/reproducible-builds/reproducible-website/-/blob/master/bin/contributors.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of the project as well as procedural documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants