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

Remove defunct .gitconfig file #2078

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

madmini
Copy link

@madmini madmini commented Jun 14, 2024

The .gitconfig is not actually used by git unless manually configured to do so. The repo-specific git config is located in .git/config. The only .gitconfig file read by git is the one in the user home directory. See git config docs and the answers to this stackoverflow question.

I believe it is misleading to have this file in the repo as it implies the config is automatically applied. I for one have wasted a lot of time trying to fix the .gitconfig file before I realized this and came up with #2077 instead.

If I am mistaken and the .gitconfig file represents recommendations for contributors or similar then I strongly recommend to have this reflected somewhere in the docs, or noted as a comment in the defunct .gitconfig file.

@madmini
Copy link
Author

madmini commented Jun 14, 2024

The options, as outlined in #191 should probably be added to the docs.
#2077 should take care of line endings.

Copy link

Build checks have not completed. Possible reasons for this are:

  1. The checks need to be approved by a maintainer
  2. The branch has conflicts
  3. The firmware build has failed

@madmini madmini force-pushed the chore/remove-defunct-gitconfig-file branch from d73e933 to a1add0a Compare November 22, 2024 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant