theupdateframework / theupdateframework/taps

POUF1 is out of date

Open
#150 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
37
Forks
23
PR merge metrics
No merged PRs in 30d

Description

Implementation Version(s) Covered: v0.12.*

We're 9 versions behind 😬.

If we do update this, I think we should try to improve content as well:

  • A lot of the POUF is just repeating spec, that seems unnecessary? Or maybe I misunderstand the purpose
  • the http API is basically undocumented: the only reference seems to be this incorrect statement

    A client downloads these files by HTTP post request

  • filenames and related "input" validation is not handled

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 locating the POUF documentation and its references to implementation versions, HTTP downloads, filenames, and input validation. Compare the material with the current implementation rather than v0.12.*, then clarify the HTTP API and validation guidance. Done means the version coverage and requested documentation gaps are addressed, with unnecessary specification repetition reviewed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.