Imageomics / Imageomics/OpenCite

Investigate .zenodo.json Download Behavior and Download-Both Option

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1d 23h
Merged PRs (30d)
5

Description

Summary

OpenCite currently generates and downloads a Zenodo metadata file using the filename .zenodo.json. However, some browsers and operating systems do not reliably preserve leading-dot filenames when downloading files from a web application. As a result, users may receive zenodo.json instead of .zenodo.json.

Current Behavior

  • OpenCite generates valid Zenodo metadata.
  • The application requests the filename .zenodo.json.
  • Some browser/OS combinations may save the file as zenodo.json instead.

Expected Behavior

When possible, users should receive a correctly named .zenodo.json file that is compatible with GitHub and Zenodo workflows.

Potential Solutions

Option 1: Keep Current Behavior
  • Continue requesting .zenodo.json.
  • Document browser limitations.
  • Users can rename the file manually if necessary.
Option 2: Add "Download Both" ZIP Export

Provide a single ZIP download containing:

  • CITATION.cff
  • .zenodo.json

Benefits:

  • Preserves the exact filename inside the archive.
  • Allows users to download both metadata files at once.

Tradeoffs:

  • Requires users to extract the archive before use.
  • Adds additional export logic and ZIP generation dependencies.
Option 3: Add User Guidance
  • Display a note explaining that some browsers may remove the leading dot.
  • Provide instructions for renaming the file if needed.

Notes

  • The application previews already display the generated metadata and can be copied directly by users if download behavior is inconsistent.
  • This issue does not affect the validity of the generated metadata, only the downloaded filename.
  • A future "Download Both" feature would likely address this issue while also improving usability.

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 reviewing the existing download behavior and the generated metadata previews, then reproduce how leading-dot filenames are handled across browsers and operating systems. Clarify whether the accepted outcome is documentation, user guidance, or a ZIP containing CITATION.cff and .zenodo.json; done means the chosen behavior is reliable and documented for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.