MATLAB R2016b	MATLAB R2015b	Code Coverage	Code Grade

MATLAB.devTools - Contribute the smart way

Pre-requisites

Please follow the configuration instructions carefully. You may skip this if your system is already set up and you have git configured.

IMPORTANT: Please make sure that you have configured your SSH key in Github as explained here.

Installation

Download this repository (the folder ./MATLAB.devTools/ will be created). You can clone the repository using:

$ git clone git@github.com:opencobra/MATLAB.devTools.git MATLAB.devTools

Run this command in Terminal (on and ) or in Git Bash (on ) - not in .

Do you want to contribute to The COBRA Toolbox?

Please follow the installation and contributing instructions.

How do I use the MATLAB.devTools?

Making a contribution to any git repository from is straightforward. Type in within the MATLAB.devTools folder:

>> contribute

You will then be presented by a menu:

   [1] Start a new feature (branch).
   [2] Select an existing feature (branch) to work on.
   [3] Publish a feature (branch).
   [4] Delete a feature (branch).
   [5] Update the fork.

-> Please select what you want to do (enter the number):

The original repository will be downloaded (cloned) the first time to a folder named fork-gitRepoName. Only files in the fork-gitRepoName folder will be considered for contribution (any changes made to a downloaded official git repository will be ignored).

If you get stuck or are faced with an system error message, please read the FAQ.

How can I update my fork without contributing?

In order to only update your fork, run >> contribute and select menu item [5].

Configure the MATLAB.devTools for another repository

The MATLAB.devTools can only be used with publicly accessible repositories.

If you want to use the MATLAB.devTools with a repository other than the default repository, you must set the following variables:

launcher = '\n\n       ~~~ MATLAB.devTools ~~~\n\n'; % a message for the repository (any string)
remoteRepoURL = 'https://server.com/repositoryName.git'; % the remote url
nickName = 'repoNickName'; % a nickName of the repository (any string)
verbose = false;  % turn the verbose mode on (true) or off (false)

and run:

>> confDevTools(launcher, remoteRepoURL, nickName, verbose);  % sets the configuration

In order to reset the configuration, type:

>> resetDevTools();

If you want your changes to be permanent, you can set the above mentioned variables in ./assets/confDevTools.m.