guidelines for contributions

Author: oscarjalnefjord

README.md

@@ -14,7 +14,7 @@ If you would like to contribute with code, please follow the instructions below:
 
 *   [Setting up Git](doc/setting_up_git.md)
 *   [How to create a copy of the respository and contribute changes to the repository](doc/create_local_copy_of_repository.md)
-*   [Guidelines for code contribution](doc/guidelines_for_contributions.md)
+*   [Guidelines for IVIM code contribution](doc/guidelines_for_contributions.md)
 *   [Guidelines to creating a test file](doc/creating_test.md) 
 
 ## Repository Organization
@@ -23,7 +23,7 @@ The repository is organized in four main folders along with configuration files
 
 The **doc** folder contains all documentation related to the repository of task force 2.4.
 
-The **src** folder contains source code contributed by the the community. Within **src**, the **original** folder contains the code to be tested, and the **wrappers** folder contains code for harmizing the calls the different code contributions. Within the **original** folders, contributions are stored in Initials_InstitutionCountry, e.g. src/original/OGC_AmsterdamUMC.
+The **src** folder contains source code contributed by the the community. Within **src**, the **original** folder contains the code to be tested, and the **wrappers** folder contains code for harmizing the calls the different code contributions. Within the **original** folders, contributions are stored in Initials_Institution, e.g. src/original/OGC_AmsterdamUMC.
 
 The **test** folder contains the test files corresponding to the contributed code in **src**. *to be structured*
 

doc/create_local_copy_of_repository.md

@@ -2,10 +2,46 @@
 
 The instructions outlined below shows a few (but far from all) ways for creating a copy of the repository and contribute with changes.
 
-# Using Visual Studio Code
-*to be added*
+# Creating a local copy of the repository
+Create a github user: [Link to Github](https://github.com/)
 
-# Alternative approach
-- Create a github user
+Create your own fork of the repository with the fork button in the upper right corner:
+
+![Fork](figs/fork.png)
+
+Copy the link of your fork:
+
+![Github_clone](figs/github_clone.png)
+
+Continue with one of the following methods:
+
+## Using Visual Studio Code
+Press the "Clone Repository" button under the "Source Control" tab and follow the instructions:
+
+![vscode_clone](figs/vscode_clone.png)
+
+## Using commandline tools
 - `git clone <repository name>`
-- e.g. `git clone git@github.com:OSIPI/TF2.4_IVIM-MRI_CodeCollection.git`
+- e.g. `git clone git@github.com:oscarjalnefjord/TF2.4_IVIM-MRI_CodeCollection.git`
+
+# Contributing changes
+If you have made changes, e.g. added new IVIM code from you group or made some change to the existing code, it can be transfered to the OSIPI repository by a commit and pull request. 
+
+First, upload your changes to github by a commit (see alternative methods below).
+
+Second, generate a pull request for the OSIPI repository maintainers to accept by pressing the "Contribute" and then "Open pull request". Follow the instructions and write a message for the maintainers such that it is understandable what changes and/or additions to the code are intended to do.
+
+![github_pullrequest](figs/github_pullrequest.png)
+
+## Using Visual Studio Code
+Press the "Commit" button under the "Source Control" tab after writing some short description of the commit e.g. "nlls fitting GU SWE":
+
+![vscode_commit](figs/vscode_commit.png)
+
+Push the changes to github with the "Sync Changes" button under the "Source Control" tab:
+
+![vscode_push](figs/vscode_push.png)
+
+## Using commandline tools
+- `git commit -am "commit message"`
+- `git push`

doc/figs/fork.png

@@ -1,10 +1,11 @@
-# Guidelines for code contribution
+# Guidelines for IVIM code contribution
+
+## How to submit
+Follow the [general instructions for code constributions](create_local_copy_of_repository.md), with the additional remarks made below. The pull request message should preferably describe, very briefly, the purpose of the code.
 
 ## Contributor Information
-*to be added*
+For each contribution make sure to list the names and affiliations of all contributors of the particular code in the message of the pull request.
 
 ## Source code format
-*to be added*
+Contributions of must be place in a folder named "Initials_Institution" under src/original, e.g. "src/original/OGC_AmsterdamUMC"
 
-## How to submit
-*to be added*