- Rules
- Requirements
- Basic Usage
- Keep the master branch always functional
- When modifying something existing or adding something new, do so in a separate branch. Once you ensure that this new branch is working and in its final version, only then merge it with the master branch to make it available to everyone, and delete the branch that was created for development.
- Files with examples of analyses should be named with 'example_' at the beginning.
- Files with data should be named with 'data_' at the beginning.
- Provide references to websites, books, and papers, both about the explanation of the analysis and the code.
- If creating an example in Jupyter notebook, also add the exported .html file.
- Install git
- Depending on the code you are going to use: Python, R, Matlab (/Octave)
- It is recommended to have Jupyter Notebook to run interactive examples (.ipynb) (Jupyter requires Python)
Simple reference for using git: http://rogerdudler.github.io/git-guide/
- Download the current version of the repository:
- If this is your first time, you still need to clone (download) the repository:
#!git
git clone https:\address up there on the top right of this page (where it says HTTPS)
- If you already have the repository, go to it and download the latest version
#!git
git pull origin master
All changes you make will only be applied to your machine.
- If you want to discard your changes and download it again:
#!git
git fetch --all
git reset --hard origin/master