search

cjolowicz / hypermodern-python

Hypermodern Python
https://medium.com/@cjolowicz/hypermodern-python-d44485d9d769
MIT License
611 stars 90 forks source link

Default branch on Github now is "main"; this conflicts with some links in the repo #171

Open Dominik1123 opened 3 years ago

Dominik1123 commented 3 years ago

Since October 2020 the default branch for Github repositories is main instead of master. Since in the repo and articles there are a few links that rely on "master" this could cause confusion for new users since some things won't work as expected:

Perhaps these should be updated to main instead? However on gitlab.com the default branch still remains master so if someone creates the repo there they face the same issues. In any case, a comment in the article would be helpful too.

cjolowicz commented 3 years ago

Thank you for reporting the issue! You are correct that some of the project cruft assumes that default branch is named master, and therefore needs to be fixed when used as a template for repositories using another branch name, like GitHub's new default. There are plans to update the blog and its companion repository for 2021, and this issue will be addressed as a part of that update.

In the meantime, I would like to point you to https://github.com/cjolowicz/cookiecutter-hypermodern-python, which (unlike this repository) was designed as a project template, and is regularly updated. Since 2020.10.15, the project template also works with repositories using the new main branch.