isaacs / isaacs/node-tar

Document reproducibility of resulting archives

Open
#395 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
922
Forks
281
PR merge metrics
No merged PRs in 30d

Description

It would be helpful to have some information documented about the reproducibility of the resulting archives. What I mean is answering this question:

Can I be sure that I am getting exactly the same TAR archive whenever I use this package? No matter:

  • When I run it.
  • Which node-tar version I use.
  • Which OS I use.

Of course, in order to ensure it, some testing would be needed. Therefore starting with something like following might suffice (in case it applies):

The archives being generated using this package are expected to be reproducible (no matter when or in which OS you run it). Nevertheless, as of now no format tests are ensuring it.

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 by locating node-tar's documentation and existing format tests, then inspect how resulting TAR archives are generated. Check whether output is consistent across runs, node-tar versions, and operating systems; done means the reproducibility result is documented and any needed format coverage is recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.