-
Notifications
You must be signed in to change notification settings - Fork 55
Contributing to Homer3 and its submodules
Homer3 uses git submodules for version control of code it shares with other applications in the openfNIRS software ecosystem.
This complicates contributing to Homer3. To contribute to code within a submodule such as DataTree or Utils, open a pull request with the submodules BUNPC/DataTree or BUNPC/Utils.
git clone https://github.com/<GitHub user>/Homer3 --single-branch -b development --recurse-submodules
To add your fork of a submodule to Homer3 repository:
Update .gitmodules with the reference to another repository (such as your fork):
git config --file=.gitmodules submodule.**<Name of submodule>**.url https://github.com/**<url of forked submodule>**
Repeat this for any submodules you intend to contribute to, i.e.
git config --file=.gitmodules submodule.DataTree.url https://github.com/sstucker/DataTree
git config --file=.gitmodules submodule.Utils.url https://github.com/sstucker/Utils
After changing the .gitmodules files, call git submodule sync
These submodules must be updated, committed to, branched, and otherwise managed like standalone Git repositories.
Join the Homer3 community on openfnirs.org!
- Homer3 Overview
- Download and Installation
- Homer3 Graphical User Interfaces
- Input and Output Definitions
- Processing Data
- Viewing Processed Data via GUI
- Exporting Processed Data into a Text File
- Exporting Processed Data into MATLAB WorkSpace
- Working with Datasets using DataTree Library
- Working with SNIRF files standalone
- Custom User Functions