esciencecenter-digital-skills / research-software-support

Content for the Research Software Support platform
https://esciencecenter-digital-skills.github.io/research-software-support/
Other
3 stars 4 forks source link

add gitignore #137

Closed DaniBodor closed 2 weeks ago

JaroCamphuijsen commented 1 month ago

I have my doubts about adding this. I would like to keep the content repositories as clean as possible, without too many files in the root folder. Also if all is well, these content repositories should not contain or generate files that have to be ignored by git because it is not software but only data. Any environments, installed packages, etc. will be generated in the NEBULA repository which does contain a gitignore file. I suppose that any of the IDE files or OS specific files can be ignored more effectively by adding them to the global git config: https://stackoverflow.com/questions/5724455/can-i-make-a-user-specific-gitignore-file

What do you think @raar1 ?

JaroCamphuijsen commented 2 weeks ago

After some consideration, I'm closing this PR. We would like to keep the content repositories as clean and simple as possible. As the content repositories are only meant to be read by the NEBULA repository, we don't need a gitignore to keep it clean. If you use and install NEBULA appropriately, no files will be created inside the content repositories. For user specific files, like editor configurations, it is better to use a local gitignore or put it in the git exclude file as described in the git documentation:

https://git-scm.com/docs/gitignore

Patterns which a user wants Git to ignore in all situations (e.g., backup or temporary files generated by the user’s editor of choice) generally go into a file specified by core.excludesFile in the user’s ~/.gitconfig. Its default value is $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore is used instead.