search

dask / community

For general discussion and community planning. Discussion issues welcome.
21 stars 3 forks source link

Renaming `master` to `main` #68

Closed jakirkham closed 1 year ago

jakirkham commented 4 years ago

Would like to suggest we rename our branches from master to main. The term master can be problematic and is something even GitHub themselves is moving away from. Suspect beyond doing the work itself, the change has minimal (if any) long term maintenance associated. Would be interested in hearing others thoughts on this 🙂

TomAugspurger commented 4 years ago

Some discussion on this for Python: https://discuss.python.org/t/communitys-take-on-changing-master-branch-to-main/4462

I'm in favor of changing this, but would happily let other projects move first and figure out what breaks :)

jacobtomlinson commented 4 years ago

I support terminology changes like this. Doing a quick search for terms like whitelist and blacklist and highlight a few things we should think about changing.

We recently had to resolve an issue where Bokeh renamed whitelist to allowlist in a non-backward compatible way. I propose we follow suit but perhaps consider making it backward compatible for a while to avoid breaking stuff for other folks.

jsignell commented 4 years ago

I agree that we should make this change.

I don't love the idea of making the whitelist/allowlist change backwards compatible unless we have a very short and clearly defined timeline for getting rid of it entirely. Breaking some things might be considered part of the goal for this work.

jacobtomlinson commented 4 years ago

Breaking some things might be considered part of the goal for this work.

Interesting I hadn't considered that.

TomAugspurger commented 4 years ago

There hasn't been any activity on https://discuss.python.org/t/communitys-take-on-changing-master-branch-to-main/4462. Does anyone know of other projects that have made the switch?

On Mon, Jul 13, 2020 at 10:23 AM Jacob Tomlinson notifications@github.com wrote:

Breaking some things might be considered part of the goal for this work.

Interesting I hadn't considered that.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/dask/community/issues/68#issuecomment-657624831, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKAOIWCJ4XE6WCJOVTY5BLR3MRGDANCNFSM4OF3NMQQ .

jacobtomlinson commented 4 years ago

Other discussions that I could find:

Of those it seems only Mozilla has gone ahead with the change already.

jsignell commented 4 years ago

Definitely not the same as OSS but we made the change at Saturn and it was pretty seamless.

TomAugspurger commented 4 years ago

FYI: https://github.com/github/renaming/.

If you haven’t moved yet, we recommend not moving right now, and waiting until later this year. We’re investing in tools to make the renaming the default branch of an existing repository a seamless experience for both maintainers and contributors.

bryevdv commented 4 years ago

FWIW we did just start this, beginning with some peripheral repos, and so far things have been relatively painless.

jacobtomlinson commented 4 years ago

It was raised in dask/dask#6922 that there are other words such as chain that we may want to consider changing for similar reasons. Diverting that discussion here to be continued.

jsignell commented 3 years ago

I think Github has now implemented all the helper utils for migrating from master to main: https://github.com/github/renaming

I am down to help with any work that this change would entail.

jrbourbeau commented 3 years ago

I'm also +1 for migrating to main and am around to help. Following up on https://github.com/dask/community/issues/68#issuecomment-680243312, is there any objection to trying this out on a smaller project first (e.g. dask-examples) as a test before moving onto repos like dask and distributed with more traffic?

FWIW scikit-learn made the switch to main recently https://twitter.com/scikit_learn/status/1352677206972051456

jacobtomlinson commented 3 years ago

Would probably be good to track this for subprojects in the same way we are doing for the GitHub Actions migration.

Also side note I wrote a blog post a while back that folks may find helpful on setting up aliases to check out and pull the default branch. I personally work on projects that use master, main, gh-pages, next, etc. So a smart alias is helpful.

jsignell commented 3 years ago

Progress:

jacobtomlinson commented 3 years ago

Quick FYI GitHub helpfully lets you know the default branch has changed and you need to run some commands to update your local clone.

However it doesn't mention that you need to head to your fork and rename the default branch there first otherwise those commands will fail.

image

jrbourbeau commented 3 years ago

Almost all of the repos in the Dask org have either made the migration from master -> main or have been archived. So far there haven't been any reported issues (that I'm aware of) as a result of the branch name change. Given this we're planning to move over dask/dask and dask/distributed soon. Just wanted to give folks tracking this issue a heads up

jsignell commented 3 years ago

@jacobtomlinson just found that read the docs caches the name of the default branch, so project maintainers may need to verify that the correct branch is being built. I am opening issues to track this now:

jsignell commented 3 years ago

I'm not sure if marketing uses read the docs.

jrbourbeau commented 3 years ago

It does and I've pointed RTD to main

jsignell commented 3 years ago

Ok then I think the list I have above is complete

jakirkham commented 2 years ago

All branches listed have been updated.

Down to the RTD issues listed above. Only a couple people have permissions on those. Tried pinging for help.

jakirkham commented 2 years ago

Think only dask-glm remains. Suggesting archiving it ( https://github.com/dask/dask-glm/issues/99 ) as it appears inactive

Edit: This is now archived

phobson commented 2 years ago

@jakirkham we recently took ownership of crick from Jim. We should rename that too. I can lead that.

jakirkham commented 2 years ago

Renaming the branch is straightforward. Happy to do that

There seem to only be a few references to master in the repo. Though those seem unrelated to the project itself. Please let me know if I'm missing anything

Edit: Went ahead and renamed the branch

jakirkham commented 1 year ago

Closing as completed