Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.vscode/ added to .gitignore because it is IDE specific #3138

Closed
wants to merge 1 commit into from

Conversation

droseger
Copy link
Contributor

@droseger droseger commented Jun 6, 2018

Apparently, the folder .vscode/ accidentally got added in a recent pull request. I propose adding the folder to .gitignore

@droseger droseger changed the title .vscode/ is IDE-specific and should be in .gitignore .vscode/ added to .gitignore because it is IDE specific Jun 6, 2018
@fredizzimo
Copy link
Contributor

I disagree with these changes. Some of the settings there are very important for having a pleasant Visual Code experience. For example, the file exclude part, without that, searching would take forever because it would try to search in output and hex files, unless you restrict it in other ways.

As can be seen here, the intent has always been for the settings.json file to be team specific and shared between the team microsoft/vscode#37519.

That said, the file commonly gets modified automatically, because we don't have enough rules for files.associations for example, so more rules should be added to them. You might also want to have some personal settings. But that's no longer an issue, with the multi-root workspaces it's possible to get the best of the two worlds, you just need to create your own workspace, see this microsoft/vscode#37519 for example.

@droseger
Copy link
Contributor Author

droseger commented Jun 6, 2018

Well, the folder was added as a byproduct of Xton's first keymap! (#2941), it clearly wasn't added because Visual Code users thought it best to do so. Besides, the same is true for .idea/: A lot of useful settings can be set there. .idea/ is already in .gitignore.
I think it has advantages not to pollute a repo with IDE files. Every one of them adds a bit of noise.

@fredizzimo
Copy link
Contributor

No I added the settings in this commit 448b916#diff-5b46cfda0ddaed371f52aa24ea2b0b2a, almost a year ago

@droseger
Copy link
Contributor Author

droseger commented Jun 6, 2018

Ok, it seems i misread the git log. It still seems weird to have this folder, though.

[Edit] If .vscode/ should be removed from the repo at all, the .gitignore should only include .vscode/, not files in this folder. I amended my commit accordingly.

@notslang
Copy link

notslang commented Jul 1, 2018

@fredizzimo Do people need to use VSCode to be able to work on QMK, or is it just something that you recommend?

@drashna
Copy link
Member

drashna commented Jul 1, 2018

@slang800 it's not required. You could use any text editor, too. But VSCode works VERY well, as it is able to process the includes, and well, include folders for code ("intellisense", I believe).

And the files included in the .vscode folder make it easier to get started, and it tells vscode how to handle some folders and files.

So, it's not necessary, but it's very helpful. And I personally don't think it's a good idea to remove then.

@drashna
Copy link
Member

drashna commented Jan 25, 2019

As there has been no update on this, and it sounds like we want to keep the .vscode files, I think we should close this PR.

If you disagree, then please re-open it!

@drashna drashna closed this Jan 25, 2019
@droseger droseger deleted the dev branch January 26, 2019 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants