### Create an account on [ENS's Gitlab].(https://gitbio.ens-lyon.fr/): <https://gitbio.ens-lyon.fr/>
### Create an account on [ENS's Gitlab].(https://gitbio.ens-lyon.fr/): <https://gitbio.ens-lyon.fr/>
...
@@ -312,7 +318,7 @@ By default, when creating the Rstudio project, a .gitignore file is added contai
...
@@ -312,7 +318,7 @@ By default, when creating the Rstudio project, a .gitignore file is added contai
This means that the Rstudio project configuration files are not tracked.
This means that the Rstudio project configuration files are not tracked.
For TP and in general, we don't want to track changes to raw data or results.
In general, we don't want to track changes to raw data or results, maybe for small metadata files **but NEVER for big raw data files !!**.
1. Add the following lines to the *.gitignore* file:
1. Add the following lines to the *.gitignore* file:
...
@@ -331,6 +337,14 @@ results/
...
@@ -331,6 +337,14 @@ results/
5. View changes on gitlab
5. View changes on gitlab
::: callout-important
# Never commit data into version control repositories
Why you should never commit data to Git:
Data should never be committed into your Git repositories. This is because git was designed to version small files of source code; committing data, a different category of things from source code, into your repositories will first and foremost lead to repository size bloat. Also, committing data into repositories means the data get shipped alongside the source code to anybody who has access to the source code. This might not necessarily be in-line with organizational practices.
:::
## Organizing your working directory
## Organizing your working directory
It's a good idea to put all your project-related files in the same folder:
It's a good idea to put all your project-related files in the same folder:
...
@@ -390,15 +404,28 @@ At the end of the course, the quality of your README.md will be particularly imp
...
@@ -390,15 +404,28 @@ At the end of the course, the quality of your README.md will be particularly imp
4. Index, commit, push ...
4. Index, commit, push ...
::: callout-important
# Never commit data into version control repositories
Why you should never commit data to Git:
Data should never be committed into your Git repositories. This is because git was designed to version small files of source code; committing data, a different category of things from source code, into your repositories will first and foremost lead to repository size bloat. Also, committing data into repositories means the data get shipped alongside the source code to anybody who has access to the source code. This might not necessarily be in-line with organizational practices.