theupdateframework / theupdateframework/specification

Specification uses object terminology to describe data structures

Open
#175 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
405
Forks
59
Avg merge
3d 4h
Merged PRs (30d)
1

Description

The specification frequently uses the terms objects, attributes and attribute-value fields. This object related terminology almost certainly reinforces the notion that JSON is the preferred/required data format.

dictionary, field and key-value may help reduce the JSON-centric nature of the specification.

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

Search the specification for uses of “objects,” “attributes,” and “attribute-value fields,” then review the surrounding terminology and the suggested alternatives “dictionary,” “field,” and “key-value.” Done means the relevant wording is consistently revised to reduce JSON-centric assumptions without changing the specification’s meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.