KristjanESPERANTO / MagicMirror-3rd-Party-Modules

This project provides an overview of all MagicMirror² modules and puts the modules through a few tests.
https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/
MIT License
17 stars 5 forks source link

Changing primary branch name to 'main' will prevent "git pull" from working #24

Closed dathbe closed 6 months ago

dathbe commented 6 months ago

The dev recommendations suggest changing any primary branches named master (a lot of them) to main. As far as I can tell, this is a purely cosmetic/semantic change, but when it is done on any module it prevents git pull from working, giving the following error:

Your configuration specifies to merge with the ref 'refs/heads/master'
from the remote, but no such ref was fetched.

I would suggest removing this recommendation (or providing instructions for working around this issue)

KristjanESPERANTO commented 6 months ago

You're right, this is a hint that can cause problems. I switched all my modules before they were used by many people, so I didn't need a clean migration strategy.

Without precise instructions on how it can be done smoothly, this is not ideal... I'll try to tackle this soon when I can clear my head. Suggestions are always welcome :-)

dathbe commented 6 months ago

I get that the word master has some historical connotations, but given that there's no functional difference...and most people won't even see the branch name when they git clone, my recommendation would be just leaving it as is, and encouraging new devs to use main. I think main is the default for new repositories.

KristjanESPERANTO commented 6 months ago

Hm... okay, without instructions on how to change the branch of your module without problems for the users, it makes little sense to list it. I don't see a solution for this right now, so I have just deactivated this check.