search

InfiniTimeOrg / InfiniTime

Firmware for Pinetime smartwatch written in C++ and based on FreeRTOS
GNU General Public License v3.0
2.63k stars 901 forks source link

Remove defunct .gitconfig file #2078

Open madmini opened 1 week ago

madmini commented 1 week ago

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 commented 1 week ago

The options, as outlined in #191 should probably be added to the docs.

2077 should take care of line endings.

github-actions[bot] commented 1 week ago

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