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

Enhance Repository Cleanliness by Updating .gitignore #545

Open
MohAnghabo opened this issue Jun 19, 2024 · 1 comment
Open

Enhance Repository Cleanliness by Updating .gitignore #545

MohAnghabo opened this issue Jun 19, 2024 · 1 comment

Comments

@MohAnghabo
Copy link

MohAnghabo commented Jun 19, 2024

Greetings Team,

During my recent contributions to our project, I observed that certain system-generated files and directories are not presently accounted for in our .gitignore file. These entries are typically auto-generated by development tools and operating systems, and their exclusion from our repository is essential to maintain its cleanliness and organization.

I recommend we include the following items in the .gitignore:

  • .vscode/ - Created by Visual Studio Code, this directory holds IDE-specific settings that are personal and not necessary for the collective project.
  • .idea/ - Similar to the above, this directory is produced by JetBrains IDEs and contains user-specific configurations that should be excluded from the repository.
  • .obsidian/ - Generated by the Obsidian note-taking app, this directory includes user-specific settings and cache, which are irrelevant to the project.

I invite everyone to share their input on this proposal. Pending no significant objections, I am prepared to implement these updates.

@thomasnyman
Copy link
Contributor

Different people use different IDEs and editors, note-taking apps, etc. You cannot really account for everyone's preferences in a repository that anyone is allowed to contribute to. Adding such system-specific files to the repository's .gitignore is a rather poor practice since it does not scale. Git supports global gitignore directives exactly for this purpose. I'd suggest you add your preferred IDEs preference directories to your global gitignore.

Alternatively, if for some reason you'd want a rule based on your preferences only to apply for a single repository, you can add it to the .git/info/exclude file in the repository in question. The stanzas there will only apply to the local repository, but do not have to be checked in as in the case of .gitignore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants