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

Ignore IDE and Editor specific files #53152

Closed
wants to merge 1 commit into from
Closed

Ignore IDE and Editor specific files #53152

wants to merge 1 commit into from

Conversation

widoz
Copy link
Contributor

@widoz widoz commented Jul 30, 2023

Someone might use Phpstorm or customize the VSCode installation, those files shouldn't be committed.

What?

Exclude IDE & Editor specific files and directories

Why?

For local development it would require less maintainance

How?

Adding some lines to .gitignore

Testing Instructions

Not relevant

Testing Instructions for Keyboard

Not relevant

Screenshots or screencast

Not relevant

Someone might use Phpstorm or customize the VSCode installation, those files shouldn't be committed.
@github-actions
Copy link

github-actions bot commented Jul 30, 2023

⚠️ Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Accessibility (a11y), [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket.
  • Labels found: [Status] Blocked.

You can learn more about the Type labels in Gutenberg here

Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing, @widoz!

The editor-specific files should be ignored locally via global .gitignore rather than maintain the list in the project.

Past examples: #2254 (comment) and #27360 (comment)

@Mamaduka Mamaduka added the [Status] Blocked Used to indicate that a current effort isn't able to move forward label Jul 31, 2023
@widoz
Copy link
Contributor Author

widoz commented Jul 31, 2023

The editor-specific files should be ignored locally via global .gitignore rather than maintain the list in the project.

@Mamaduka thanks for the reply. The problem is that, you might have multiple projects for which you want to have those files under versions. Does not the global force that for all local projects?

@Mamaduka
Copy link
Member

I believe you can use the ! prefix and negate patterns from global .gitignore.

Example

!.idea
!.vscode/settings.json
@widoz
Copy link
Contributor Author

widoz commented Aug 1, 2023

I believe you can use the ! prefix and negate patterns from global .gitignore.

@Mamaduka but at that point for only one single project I'm forced to change the .gitignore of a bunch of other projects. What's the main point to not have those files ignored in this project if them are not necessary?

@Mamaduka
Copy link
Member

Mamaduka commented Aug 1, 2023

The project has 100+ contributors; if everyone starts adding their environment-specific files to .gitignore, we would have an extensive list to maintain. It's recommended to handle those via personal global git ignore files.

General solutions like these might not work for some, but they make maintaining the project easier.

I'll have to close this PR as wontfix.

@Mamaduka Mamaduka closed this Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Blocked Used to indicate that a current effort isn't able to move forward
2 participants