Skip to content

Contributing docs - #592

Merged
joshmoore merged 2 commits into
ome:mainfrom
govekk:contributing_docs
Aug 31, 2026
Merged

Contributing docs#592
joshmoore merged 2 commits into
ome:mainfrom
govekk:contributing_docs

Conversation

@govekk

@govekk govekk commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Cleaning up the contributing experience a little:

  • Added link from readme to page that actually has instructions for contributing to this repo
  • Instructions for submodules
  • Instructions for sphinx-autobuild

Lingering question: there's the foundations of an all-contributors table in the readme, but it's currently blank. We could either build that or just delete it and the .all-contributorsrc, perhaps linking to https://github.com/German-BioImaging/ome-zarr-acknowledgments instead. Thoughts?

@lubianat

@github-actions

Copy link
Copy Markdown
Contributor

Automated Review URLs

@lubianat

Copy link
Copy Markdown
Contributor

Thanks @govekk! Changes look good to me; perhaps we should have documentation on how to contribute / build the website on github too (and not only on the built version)?

On the all-contributors table, I am open for suggestions. But you are right that it needs adressing!

I'll ping @jo-mueller who may have additional thoughts here

Comment thread contributing/website/index.md
@govekk

govekk commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @govekk! Changes look good to me; perhaps we should have documentation on how to contribute / build the website on github too (and not only on the built version)?

I edited the main readme to link to link to https://github.com/ome/ngff/blob/main/contributing/website/index.md - do you think that's a good enough format of documentation for on github, or I could put more info directly in the readme?

@lubianat lubianat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it works. Thank you @govekk !

@lubianat

Copy link
Copy Markdown
Contributor

@jo-mueller are you ok? or yet pending changes?

@jo-mueller

jo-mueller commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

didn't know about the auto-build either, cool stuff 👍

@joshmoore
joshmoore merged commit a13d4f6 into ome:main Aug 31, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants