We use this repository to gather feedback from the community regarding the "JNIfTI Format Specification", or JNIfTI format. Such feedback is crucial to finalize this file specification and help improve it in the future once disseminated.
The latest version of the JNIfTI specification can be found in the file named JNIfTI_specification.md. The specification is written in the Markdown format for convenient editing and version control.
The JNIfTI format is built upon the JData specification - a generalized framework to serialize and convert complex scientific data.
You can use a number of methods to provide your feedback to the working draft of this file specification, including
- Create an "Issue"
- This is the most recommended method to provide detailed feedback or discussion. An "Issue" in github is highly versatile. One can ask a question, report a bug, provide a feature request, or simply propose general discussions. Please use URLs or keywords to link your discussion to a specific line/section/topic in the document.
- Comment on the latest released version of the specification
- Each released version of the specification is available on the GitHub Releases page. To add a comment, you need to first register a GitHub account, then browse the release page. When hovering your cursor over each line of the specification, a "plus" icon is displayed; clicking it allows you to comment on a specific line or reply to others' comments.
- If the discussion becomes extensive, please consider opening an Issue instead.
- Use NeuroJSON Forum
- You may send your comments to the neurojson Github forum. You may report bugs, new features, or submit new datasets.
For anyone who wants to contribute to the writing or revision of this document, please follow the below steps
- Fork this repository and make updates, then create a pull-request
- Please first register an account on github, then, browse the JNIfTI repository; on the top-right of this page, find and click the "Fork" button.
- once you fork the JNIfTI project to your own repository, you may edit the files in your browser directly, or download to your local folder, and edit the files using a text editor;
- once your revision is complete, please "commit" and "push" it to your forked
git repository. Then you should create a pull-request against the upstream
repository (i.e.,
NeuroJSON/jnifti). Please select "Compare cross forks" and select"NeuroJSON/jnifti"as "base fork". Please write a descriptive title for your pull-request. The project maintainer will review your updates and choose to merge to the upstream files or request revision from you.