Skip to content

Add authors to project metadata#31

Open
jo-mueller wants to merge 30 commits intoome:mainfrom
jo-mueller:add-authors
Open

Add authors to project metadata#31
jo-mueller wants to merge 30 commits intoome:mainfrom
jo-mueller:add-authors

Conversation

@jo-mueller
Copy link
Copy Markdown
Contributor

@jo-mueller jo-mueller commented Nov 24, 2025

Fixes ome/ngff#315

Acknowledgement

Authors and Contributors to the ngff specification should be acknowledged for their contributions, as pointed out in ome/ngff#315. At the 2025 NGFF Hackathon in Zürich, it was suggested to use the following list as a criterion for inclusion as an author:

  • Contributed to repo (see repo insights)
  • Wrote an RFC
  • Wrote an RFC comment
  • Wrote an RFC review

Authorship order

Right now, authorship for the next release is divided in two categories:

  • Category 1: NGFF involvement. This includes having done one of the following:
    • Wrote an RFC
    • Wrote an RFC review
    • Wrote an RFC comment
  • Category 2: This category contains (in alphabetical order) all contributors to this repository.

A future update to this "policy" may expand eligibility for authorship to contributions to the broader community, such as

  • contributions to the ngff repo
  • tool maintenance
  • attending a Hackathon
  • Writing documentation
  • etc.

all of which are valid and helpful, but the criteria need to be fleshed out in more clarity before adding this.

@jo-mueller jo-mueller added the documentation Improvements or additions to documentation label Nov 24, 2025
@github-actions
Copy link
Copy Markdown

Automated Review URLs

@lubianat
Copy link
Copy Markdown
Contributor

maybe a way forward would be

  • auto-generating the CITATION.cff file from the myst.yml one
  • ordering names in CITATION.cff using GitHub stats for contribs in ngff-spec + ngff

Eventually one could order by contributions to that particular spec version or some other kind of optimization. Currently it seems like it is ordered by git shortlog -sn or similar on ngff.

@jo-mueller
Copy link
Copy Markdown
Contributor Author

@lubianat thanks for the feedback. One can do

Jupyter book build --cff

Which constructs the cff file from the myst.yaml. The CI just would need to make sure to also commit the built file 🤔

As for authorship I thinkthe issue with contrib is that this doesn't reflect contributions to the rfc process. In the case of rfc5, a bunch of people deserve acknowledgement, but the main contributor of the respective PR is just me ^^"
My idea wod be to have three tiers of authors:

  • Tier 1: Editors, listed first
  • Tier 2: RFC authors & reviewers (order to be determined)
  • Tier 3: Other contributions to ngff-spec by alphabetical order

Not sure who can decide this, though.

@lubianat
Copy link
Copy Markdown
Contributor

I agree, it is complex. Though the version 0.6 is different from RFC 5, so one has to consider how to balance previous contributions to the spec and the contributions to a particular version.

I think that using the size of total contributions is what was done in 0.5 (https://zenodo.org/records/14755796).

It may make sense to keep the simpler/straightforward heuristic for the 0.6 time frame and perhaps organize it better for 1.0.

The OME meeting seems like a good moment to make these kinds of tweaks.

@jo-mueller
Copy link
Copy Markdown
Contributor Author

jo-mueller commented Feb 19, 2026

The OME meeting seems like a good moment to make these kinds of tweaks.

Good idea 👍 It *is an ome repository after all so it seems fitting for the OME body to make this kind of decisions.

@lubianat
Copy link
Copy Markdown
Contributor

lubianat commented Apr 1, 2026

Error in build:

File "/home/docs/checkouts/readthedocs.org/user_builds/ngff-spec/checkouts/31/pre_build.py", line 175, in render_authors_md
affiliations = data['project']['affiliations']
~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^
KeyError: 'affiliations'

(other than that, looks ok)

@lubianat
Copy link
Copy Markdown
Contributor

lubianat commented Apr 1, 2026

LGTM
grafik

@joshmoore
Copy link
Copy Markdown
Member

👍 on punting on the affiliations. Not as a blocker but just a heads up -- github logo on dark mode basically disappears

image

@jo-mueller
Copy link
Copy Markdown
Contributor Author

@joshmoore looks better now :)

@joshmoore
Copy link
Copy Markdown
Member

Nice! TIL

@jo-mueller
Copy link
Copy Markdown
Contributor Author

jo-mueller commented Apr 1, 2026

@bogovicj @LucaMarconato @d-v-b @will-moore @thewtex @toloudis @fcollmann @dyf @jburel @jrswedlow @ilan-gold @jbms @dstansby @sbesson @chris-allan @clbarnes @tcompa @LDeakin @imagejan @glyg @xgui3783 @yarikoptic @matthewh-ebi @JulianHn @minnerbe @mkitti @tlambert03 @melissalinkert @ziw-liu @jluethi @jni @bugraoezdemir @giovp @constantinpape @perlman @sebi06 @normanrz @virginiascarlett @dpshepherd @tischi @vuhlmann @melonora @ivirshup @AlanMWatson @jwindhager @kevinyamauchi @yuriyzubov @dzenanz

I am adding you explicitly as authors here, so that your contributions are acknowledged and citable on Zenodo with the next big release that goes out. I managed to find most your orcids/github accounts, but please do check briefly whether I put your details into the list correctly.

Note: I am avoiding affiliations here, as they should be sufficiently clear from orcid records ;)

Thanks!

edit: The CITATION.cff is auto-generated from myst.yaml, so you only need to check there 👍

Copy link
Copy Markdown
Contributor

@dzenanz dzenanz left a comment

Choose a reason for hiding this comment

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

My orcid is 0000-0002-9546-9703.

@AlanMWatson
Copy link
Copy Markdown
Contributor

My ORCID: 0000-0003-0632-8296
Thank you!

@dpshepherd
Copy link
Copy Markdown

name: Douglas Shepherd
github: dpshepherd
orcid: 0000-0001-9087-0832

Thanks!

@JulianHn
Copy link
Copy Markdown
Contributor

JulianHn commented Apr 1, 2026

Hey,

I am not complaining about a mention obviously, but my contribution to this repo was merely a fix to a small website bug, so I am not really sure if I should really appear as an author regarding the ngff spec.
I would love to be more involved in the OME development again, but alas only too many responsibilities for 24 hours of daytime.

Just wanted to actively mention this and let you know that you can feel free to remove me from the author list!

Thanks for all the effort you put into this

@jluethi
Copy link
Copy Markdown
Contributor

jluethi commented Apr 2, 2026

@jo-mueller Can we also add @lorenzocerrone (RFC-8 co-author, so I think that qualifies under the proposed author guidelines)?

name: Lorenzo Cerrone
github: lorenzocerrone
orcid: 0000-0001-7337-2313

Co-authored-by: Ziwen Liu <67518483+ziw-liu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand authorship of spec to all contributors