Thank you for taking the time to contribute to the package!
The following is a set of guidelines for contributing to Open Source MRF Package. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
If you would like to contribute to Open Source MRF Package, please fork and make a pull request with adequate documentation of functionality. In addition, please take a look at the Code of Conduct and documentation guide below:
Code of Conduct
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to imr.framework2018@github.com.
Source code header
Insert and fill out the following header comments at the top of every script in your source code:
Institution : (your university/research facility)
Version : 1.0.0
Note that "Version" refers to the Open Source MRF Package release you developed your code on. You can add more fields if needed.
Documenting source code
Please add a top-level description of code functionality in each script. In addition, document all inputs and outputs and add a line of description for each input and output.
Please report issues in Github Issues, following the given format for either "Bug Report" or "Feature Request".
For support in installing and using Open Source MRF Package, please feel free to either use Github Issues.