We actively welcome contributions from the fNIRS community. Contributions may take many forms including suggested text changes, highlighting areas of ambiguity, reports of incompatibility, etc. Please use the GitHub issues tracker to make your contributions, we can then publicly work with you to merge your contribution in to the SNIRF specification.
We use this repository to gather feedback from the community regarding the "Shared Near Infrared Spectroscopy Format", or SNIRF specification.
The latest version of the SNIRF specification can be found in the file named snirf_specification.md. The specification is written in the Markdown format for convenient editing and version control.
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.
- One can browse the commit history of the specification document. If anyone is interested in commenting on a particular update, you can also comment on any of the commit page using the same method.
- Use the snirf mailing list
- You may send your comments to the snirf mailing list (snirf at fnirs.org). Subscribers will discuss by emails, and if a motion is reached, proposals will be resubmitted as an Issue, and changes to the specification will be associated with this issue page.
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 SNIRF repository; on the top-right of this page, find and click the "Fork" button.
- once you fork the SNIRF 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;
- if you make a change to the specification (i.e. not a trivial change to the README) then add a line item to the CHANGELOG.md file;
- 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., fNIRS/snirf). Please select "Compare cross forks" and select "fNIRS/snirf" as "base fork". Please write a descriptive title for your pull-request and detailed description of the change. The project maintainers will review your updates and choose to merge to the upstream files or request revision from you.