opencontainers / opencontainers/image-spec

Define image-related action nomenclature

Open
#467 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4.5k
Forks
891
Avg merge
27d 2h
Merged PRs (30d)
1

Description

The image-tools repository has a few different terms that are being applied to image layouts that seems unintuitive or confusing. To ensure that tools have operational parity, it seems like a solid idea to define the terminology for this common operations.

Specifically, we should define the high-level terms for "unpack", "create", "pack", "verify" (?).

This will make it clear what functionality the specification actually provides.

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

Review the existing image-layout terminology in the image-tools repository and compare how “unpack,” “create,” “pack,” and “verify” are currently used. Document agreed high-level definitions and clarify which operations the specification provides. The issue has no named files or tests, so locating the relevant specification text is part of the work.

Written by the indexing model from the issue text.

Assessment

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.