Skip to content

Conversation

@egrace479
Copy link
Member

Add .zenodo.json to the "Recommended Files" section of the GitHub Repo Guide. This includes some editing/links between the Zenodo part of the DOI Generation page and the GitHub Repo Guide.

I also added instructions on how to add the Zenodo DOI badge to a repo. This line should perhaps be rephrased to incorporate "This only has to be done once..." under a "Pro Tip" admonition, instead of the current "Warning". Interested in your thoughts.

Closes Imageomics Guide Issue 26.

@egrace479 egrace479 requested review from hlapp and thompsonmj October 24, 2025 22:44
@egrace479 egrace479 added the enhancement New feature or request label Oct 24, 2025
Copy link
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. See one inline edit.

For me data are still plural, and hence metadata are too, but I realize that it is now often treated as singular, so I've left that as is (it says This metadata rather than These metadata).

```

!!! example "Example `.zenodo.json`"
The [Zenodo JSON for BioCLIP 2](https://github.com/Imageomics/bioclip-2/blob/main/.zenodo.json) provides an example that includes a grant, references, and an associated paper (`related_identifiers`), which is also listed under `notes` [for additional citation](https://zenodo.org/records/17049307). We also recommend including [this format test workflow](https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/.github/workflows/validate-zenodo.yaml), which will run if either the `.zenodo.json` or the workflow itself is edited.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The [Zenodo JSON for BioCLIP 2](https://github.com/Imageomics/bioclip-2/blob/main/.zenodo.json) provides an example that includes a grant, references, and an associated paper (`related_identifiers`), which is also listed under `notes` [for additional citation](https://zenodo.org/records/17049307). We also recommend including [this format test workflow](https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/.github/workflows/validate-zenodo.yaml), which will run if either the `.zenodo.json` or the workflow itself is edited.
The [Zenodo JSON for BioCLIP 2](https://github.com/Imageomics/bioclip-2/blob/main/.zenodo.json) provides an example that includes a grant, references, and an associated paper (`related_identifiers`), which is also listed under `notes` [for additional citation](https://zenodo.org/records/17049307). We also recommend including [this format validation workflow](https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/.github/workflows/validate-zenodo.yaml), which will run if either the `.zenodo.json` or the workflow itself is edited.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add How to add the DOI Badge to the DOI Generation page

2 participants