theupdateframework / theupdateframework/theupdateframework.io

Add contributors page

Open
#38 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
25
Forks
46
PR merge metrics
No merged PRs in 30d

Description

https://github.com/theupdateframework/python-tuf/issues/1807 removes the unmaintained AUTHORS.txt, because it fits better within the scope of the wider TUF project, that is not all organizations and individuals listed in the document are/were affiliated with python-tuf.

We should re-add an up-to-date TUF authors/contributors document either to the website or to a project-wide repository (e.g. github.com/theupdateframework/community <- does not exist yet) to acknowledge the efforts of our contributors.

@joshuagl suggests to auto-generate the document from git commits (of which repo?).

Sync with #37

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the removed docs/AUTHORS.txt in python-tuf and the linked issue #1807, then determine which repository's git commits should be used and whether the document belongs on the website or in a wider TUF repository. Done means an agreed location and an up-to-date TUF authors/contributors document that acknowledges contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, html
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.