Smithsonian / Smithsonian/layup

Test that .zenodo.json and paper.md agree on authors and affiliations

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
10
Forks
2
Avg merge
1d 43m
Merged PRs (30d)
58

Description

paper/paper.md and .zenodo.json both carry the author list, affiliations and ORCIDs, with nothing keeping them in step. They drifted once already: .zenodo.json was generated from paper.md on 08-25, #488 renumbered the affiliations on 08-26, and @mschwamb caught the mismatch reviewing #480.

It matters because .zenodo.json sets the author list on the archived record, which is what people cite, and nobody re-reads it before the DOI is minted.

Suggested test: parse both, check the same authors in the same order, matching ORCIDs, and each author resolving to the same institution names. Names, not index numbers — a renumbering can be correct in the affiliation list and still leave a stale index on one author, which is what happened to J. Moeyens in #488 ("8,13", where 8 had come to mean something else). An index comparison passes that.

Needs #480 to land first, since .zenodo.json is not on main yet.

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

After #480 lands, start by reading paper/paper.md and .zenodo.json and identify the repository's existing Python test entry point. Add a test that compares authors in order, ORCIDs, and resolved institution names rather than affiliation indices; done means the test catches stale or renumbered author affiliations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.