search

datamade / how-to

📚 Doing all sorts of things, the DataMade way
MIT License
81 stars 12 forks source link

Guidance and policy on renaming master branch to main #209

Closed derekeder closed 2 years ago

derekeder commented 3 years ago

Documentation request

For new projects in GitHub, the default branch name is now main. However, for existing repositories, the default branch is still master. I'd like to provide guidance and a policy to rename the main branch to main for legacy projects whenever they come under active development.

GitHub provides some helpful tools to make this transition easier: https://github.com/github/renaming

For our projects, there will be additional places where this reference may need to be updated, including:

Related to #198

hancush commented 3 years ago

Also add estimate of how much time these changes take.

derekeder commented 2 years ago

I'm going to do this one more time for Risk & Reach and then document based on that and CPS

derekeder commented 2 years ago

@hancush I'm ready to write up this documentation. Under what section do you think it makes the most sense to add to? Should we create a new github folder or someplace else?

hancush commented 2 years ago

Great question, @derekeder. I like the idea of a new folder. How about work-practices/version-control/? That would also give us a better home for Best practices for working with source control (which I can never find) and keep it agnostic of GitHub vs. GitLab, since we're increasingly using both.