diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40dd22e651b33da7a44430d9c77235a44a9b82a2..51a8693edf599074a492bbd93f9b357622f559ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,4 +4,17 @@ Contributions to this project are very welcome. Changes should be submitted by merge request from a new branch to `master`. Merge requests should be reviewed by at least one Maintainer before merging. -See `README.md` for information on the structure of the repository. \ No newline at end of file +See `README.md` for information on the structure of the repository. + +## Step by step guide + +To contribute to this project, please follow those steps: + +1. Clone this repository: `git clone https://git.embl.de/grp-bio-it/image-analysis-training-resources.git` +1. On your computer, make a new branch. For example, if you would like to contribute python code to the binarization.md module you may: `git checkout -b pythonBinarization` +1. Now add your changes on your computer (staying in this branch). +1. When you are done, please `git add .; git commit -m "some message"` +1. Now you can upload your branch to the online repository by typing: `git push --set-upstream origin pythonBinarization`. +1. Go to the online repository on gitlab: https://git.embl.de/grp-bio-it/image-analysis-training-resources +1. On gitlab, there will now be button at the top of the page. Click this button to stage a "merge request" of your contribution (in your branch) to the master branch. There will also a possibility to assign a project maintainer to review your contribution and to merge it. Please select someone appropriate here. +1. Thank you for your contribution! diff --git a/TEACHING.md b/TEACHING.md new file mode 100644 index 0000000000000000000000000000000000000000..d75361ebeb07c69a27010d62be9af433b255529d --- /dev/null +++ b/TEACHING.md @@ -0,0 +1,19 @@ +# Teaching tips + +## White-boards + +- Try to frequently use white-board, because: + - It makes teaching more interactive. + - It slows down teaching, because you have to draw. +- Make sure you have good pens with high contrast. +- Have two white-boards: + - One for tidy concept maps. + - One for messy notes. + +## Stand + +- Try not to sit, because: + - Teaching will be more dynamic. + - People can see and hear you better. +- Construct something to have your computer up, such that you can stand in front of it. +