theupdateframework / theupdateframework/python-tuf

Enhancing The Update Framework (Python - TUF) README

Open
#2,654 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
304
Avg merge
1d 2h
Merged PRs (30d)
17

Description

Description of issue or feature request:
I would like to request an enhancement for the README of The Update Framework (TUF) repository. The goal is to improve the structure, clarity, and accessibility of the README to make it more informative and user-friendly.

Current behavior:
The current README lacks a clear structure, making it difficult for users to navigate and find relevant information quickly. Additionally, some sections could be more concise.

Expected behavior:
I propose the following changes to enhance the README:

  1. Add a Table of Contents: Improve navigation and accessibility.
  2. Improve the Introduction: Provide a clear and concise overview of TUF in 2 - 3 lines.
  3. Expand the "About TUF" Section: Add more context about its significance and applications.
  4. Highlight Key Features: Create a section listing key features and benefits.
  5. Reorganize the Documentation Section: Enhance user-friendliness and navigation.
  6. Add Visuals: Incorporate diagrams or images for better understanding.
  7. Change Logo Color: Modify the logo from black to white to enhance visibility.
  8. Add Badges: Include additional badges to highlight key aspects like version, license, tech-stack and community support.

Contributor guide

Open the contributing guide

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 with the repository README and review its current structure, introduction, documentation links, logo, and badges. Compare the existing content with each requested improvement, then define a focused set of README edits and any visual assets needed. Done means the README is clearer and easier to navigate, with the requested sections, visuals, logo treatment, and badges addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.