{"id":13752497,"url":"https://github.com/ome/ngff","last_synced_at":"2025-05-09T19:32:17.441Z","repository":{"id":37911802,"uuid":"313652456","full_name":"ome/ngff","owner":"ome","description":"Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.","archived":false,"fork":false,"pushed_at":"2025-05-09T12:30:58.000Z","size":2661,"stargazers_count":132,"open_issues_count":111,"forks_count":46,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-09T13:45:53.968Z","etag":null,"topics":["bioimaging","cloud","data-science","file-formats","spec"],"latest_commit_sha":null,"homepage":"https://ngff.openmicroscopy.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ome.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-17T14:55:39.000Z","updated_at":"2025-05-09T12:31:02.000Z","dependencies_parsed_at":"2024-02-05T03:46:29.671Z","dependency_job_id":"f3f9c018-80d7-4c9e-b1ba-414f361d02c4","html_url":"https://github.com/ome/ngff","commit_stats":{"total_commits":570,"total_committers":31,"mean_commits":"18.387096774193548","dds":0.6912280701754385,"last_synced_commit":"afc56055fe9282118a7864a1b5ed12095fcfad64"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":"w3c-ccg/markdown-to-spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fngff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fngff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fngff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fngff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ome","download_url":"https://codeload.github.com/ome/ngff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253312340,"owners_count":21888624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bioimaging","cloud","data-science","file-formats","spec"],"created_at":"2024-08-03T09:01:06.718Z","updated_at":"2025-05-09T19:32:17.320Z","avatar_url":"https://github.com/ome.png","language":"TypeScript","funding_links":[],"categories":["Ranked by starred repositories"],"sub_categories":[],"readme":"[![DOI](https://zenodo.org/badge/313652456.svg)](https://zenodo.org/badge/latestdoi/313652456)\n\n# ome-ngff\n\n[Next-generation file format (NGFF) specifications](https://ngff.openmicroscopy.org/latest/) for storing bioimaging data in the cloud.\n\n## Editing\n\nSpecifications are written in markdown, or technically\n[bikeshed](https://github.com/tabatkins/bikeshed) -- a markdown document, with\nspecial extensions understood by the bikeshed tool. The bikeshed tool is run\non-commit via the [spec-prod github action](https://github.com/w3c/spec-prod),\ngenerating the familiar \"spec looking\" ReSpec format. ReSpec is just html with\na javascript ReSpec library.\n\nSpecification files end with the .bs file extension. The github action runs on\ncommit to automatically convert to respec/html, via bikeshed. \n\n[Learn more about bikeshed](https://w3c-ccg.github.io/bikeshed_instructions.html)\n\n## Reviewing\n\nCommits on GitHub can be viewed using web services from the W3C:\n\n * Rendered page: http://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/ome/ngff/master/0.2/index.bs\n * Diff: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fngff.openmicroscopy.org%2F0.2%2F\u0026doc2=http%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fome%2Fngff%2Fmaster%2Flatest%2Findex.bs\n\n## New version\n\n* Make new changes to `latest/index.bs`\n* Update changelog at the bottom of `latest/index.bs`\n* Find references to previous version and _in most cases_, bump to the current version.\n\n## JSON schemas\n\nFor each top-level metadata key of the OME-NGFF specification, JSON schemas are maintained\nfor each version of the specification and stored under `$VERSION/schemas/` or `latest/schemas/`.\nTests validating these schemas must be implemented to follow principles of the\n[JSON schema test suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite)\nand stored under `$VERSION/tests/` or `latest/tests/` to allow their execution on each CI build.\n\nAll official example snippets must also be extracted and managed as separate JSON files under\n`$VERSION/examples/` or `latest/examples/`, validated by the appropriate schema by adding a\n`.config.json` file specifying the JSON schema to use and included in the\nspecification document using the\n[include-code](https://tabatkins.github.io/bikeshed/#including-code) directive.\n\nThe official OME-NGFF JSON schemas are published under\nhttps://ngff.openmicroscopy.org/\u003cversion\u003e/schemas/\u003cschema_name\u003e.schema using the\n[Spec prod](https://github.com/ome/spec-prod) GitHub action. When a new JSON schema is introduced,\nthis action needs to be reviewed to update the deployment script and allow the publication\nof the schema.\n\n# Release process\n\n* copy `latest/index.bs` to `$VERSION/index.bs`\n* copy `latest/copyright.include` to `$VERSION/copyright.include`\n* update the head matter in the `$VERSION`ed file\n  * Use: `Status: w3c/CG-FINAL`\n  * Update `URL: `\n  * Use the following `Status Text:`: \"This is the $VERSION release of this specification.\n    Migration scripts will be provided between numbered versions. Data written with the latest version\n    (an \"editor's draft\") will not necessarily be supported.\"\n* update the footer matter in the `$VERSION`ed file\n  * Version in the citation block including release date\n* Update https://github.com/ome/spec-prod for the new version\n\n# Citing\n\nPlease see https://ngff.openmicroscopy.org/latest#citing for the latest\ncitation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fome%2Fngff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fome%2Fngff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fome%2Fngff/lists"}