JGIFTI Format Specification

This repository hosts the JGIFTI Format Specification and serves as the primary venue for community feedback. Your feedback is essential to refining and improving the specification over time.

The latest version of the specification is available in JGIFTI_specification.md, written in Markdown for convenient editing and version control.

JGIFTI is built upon the JData specification, a generalized framework for serializing and exchanging complex scientific data.

How to participate

There are several ways to provide feedback on the specification:

• Open an Issue (recommended)
  • Issues are the preferred channel for detailed feedback and discussion. Use them to ask questions, report errors, request features, or start general discussions. Include URLs or section references to link your feedback to specific content.
• Comment on an RFC commit
  • Each milestone version of the specification is published as an RFC (Request for Comments) commit, in which the entire file is removed and re-added so that every line is open for inline comments. To comment, register a GitHub account and open the RFC commit page. Hovering over any line reveals a "+" icon; clicking it lets you add a comment or reply to an existing one.
  • If the RFC page becomes crowded, use the Issues section instead.
  • You can also comment on any individual commit in the repository history using the same method.
• Post to the NeuroJSON Forum
  • Use the NeuroJSON GitHub Discussions forum to report bugs, propose features, or share datasets.

To contribute edits or additions to the document directly:

• Fork this repository, make your changes, then open a pull request.
  • Register a GitHub account and visit the JGIFTI repository. Click the "Fork" button at the top right.
  • Edit files in your browser or clone the fork locally and use any text editor.
  • Once your changes are ready, commit and push them to your fork, then open a pull request against NeuroJSON/jgifti. Select "Compare across forks" and set NeuroJSON/jgifti as the base fork. Write a descriptive title for your pull request. The project maintainer will review your changes and either merge them or request revisions.