Add CFF citation support and contribution instructions #25
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added metadata to the jupyter book
myst.ymlthat contains everything that's necessary to generate aCITATION.cffmetadata. Whenever a new contributor opens aPR to this repo, they should add their data to theauthorssection in themyst.yml. A citation.cff can then be built when someone makes their first contribution.May supersede ome/ngff#175?
Long Copilot description
This pull request introduces improvements to citation metadata, author attribution, and documentation formatting for the NGFF specification project. The main changes include adding a standardized
CITATION.cfffile, updating the project metadata inmyst.ymlto support citation export, and ensuring consistent author information across documentation and auto-generated files. Additionally, the contribution guide now instructs new contributors on how to add themselves as authors and update citation metadata.Citation and Metadata Improvements
CITATION.cfffile tongff_spec/, including project abstract, keywords, license, repository links, and preferred citation details for the NGFF specification and related publications.ngff_spec/myst.ymlto include acffexport configuration, embedding citation metadata for software and articles, and listing author and publication identifiers.Author Attribution and Contribution Process
ngff_spec/contribute.mdto instruct first-time contributors on adding themselves to the author list inmyst.ymland on rebuilding theCITATION.cfffile as part of the PR workflow.examples.md,schemas.md, and files generated bypre_build.py. [1] [2] [3] [4] [5] [6] [7]Documentation Formatting
citing.md,contribute.md,examples.md,schemas.md,version_history.md) to use YAML front matter for improved consistency and compatibility with Jupyter Book and MyST Markdown. [1] [2] [3] [4] [5]These changes streamline citation management, improve contributor recognition, and ensure consistent formatting across the NGFF specification documentation.