gitignore
gitignore copied to clipboard
github
Add rider cache directory to Unity ignore list
Reasons for making this change:
Many Unity developers work with JetBrains Rider. As the Unity.gitignore considers VSCode files it should also consider Rider files.
Riders .idea folder contains a mix of cache, user/shared configuration and settings files. Similar to Visual Studios .vs folder it should be ignored. There may be some files (e.g shared dictionaries and settings) in this folders that could be shared. Sadly JetBrains does not separate local from shared files via folder structure. Thus it is easier to ignore the folder and later on explicitly state exceptions for files one would consciously share.
Links to documentation supporting these rule changes:
This is JetBrains recommendation on which of the files in the .idea folder to ignore: https://rider-support.jetbrains.com/hc/en-us/articles/207097529-What-is-the-idea-folder- The comments are already mentioning though that some files are missing from this official recommendation. This is their recommended gitigonre file https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore It is quite complex though and is not future proof as it may miss Rider generated files added in the future.
As long as Rider does not clearly separate their local files from their shared files I would recommend to ignore this folder completely.
It looks like there are some duplicate PRs with this same change: #3543, #3665, #3681, and #3687.
This would be very useful indeed! I do this manually for every project as well.
It seems like this change is no longer necessary as Rider adds its own .gitignore file in the .idea folder now. This leaves it to JetBrains to decide which files should be shared vs which should be local. However I could not find any changelog or documentation regarding this file. It would be nice if anybody could validate that this change is no longer necessary. If so this PR could be closed without merging.