Add rider cache directory to Unity ignore list #3529
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Riders .idea folder contains a mix of cache, user 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. These can later be manually excluded from the ignore file.
kbakdev
approved these changes
Oct 23, 2020
This was referenced Mar 30, 2021
Closed
|
This is a good change. I do this manually for each project right now. |
|
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 PR is stale because there have been no updates in 90 days. It will close after 180 days of inactivity. Leave a comment if you want to keep it open 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.