This set of steps and tools are highly recommended for working with a consistent set of tools and methods, same as we are use to in the lab...
...
...
@@ -26,6 +25,7 @@ This set of steps and tools are highly recommended for working with a consistent
6 - your gitlab project
- write a reamde.md, MarkDown format containing at least :
* strucutre of your repo
* quickstart guide (to lauch our wwork)
* depenedncies (including conda env management)
...
...
@@ -34,10 +34,15 @@ This set of steps and tools are highly recommended for working with a consistent
- a src/ will contain your code
- a doc/ will contain your report, biblio etc. (and include the papers you have found) -
- good practices :
* do not push binary files (exception on .pdf for your report to open it fast, images & cie for easy compilation). For large binary files (e.g. viedos) see below
* use english
* at least 1 commit + push a day. But as many as you want. Use explicit messages with a "tag" in brackets for your commit messages (e.g: "[dev] implementing awesome feature showing that P = NP ")
* use latex for your reports (you can use overleaf, but be shure to push src + pdf on your gitlab too)
* put large binaries files on the gitlab package. Tutorial [here](https://gitlab.isae-supaero.fr/hy7one/gitlabadmin/process)
6 - if you are using python, use conda envrionment