Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set master as the default branch. #1072

Closed
LoreleiAurora opened this issue Jan 4, 2017 · 9 comments
Closed

Set master as the default branch. #1072

LoreleiAurora opened this issue Jan 4, 2017 · 9 comments

Comments

@LoreleiAurora
Copy link
Contributor

We should set master as the default branch so new installs do not get bleeding edge undocumented code, that can change frequently during development.

@jeremyfelt
Copy link
Member

I like develop as the default branch, as everything on GitHub is for development. 😄

I think one of the objectives of cleaning up our documentation will also be to make it more obvious that other versions can be used. In an ideal world, users would use varyingvagrantvagrants.org to get started rather than GitHub.

At some level, we're in an unusual spot that's causing a bit of pain but will be resolved shortly. We're not often making larger changes that can impact things long term.

Another issue with switching back to master is that any new pull requests are automatically opened against that, so it adds another hurdle to the contributor experience.

@kopepasah
Copy link
Contributor

Leaving develop branch as default is ideal. I feel that it is up to a user to know which version she/he wants to run.

Documentation will definitely help alleviate any confusion.

@mkjonesuk
Copy link

I'm with @LoreleiAurora - running a bleeding edge caused me a couple of days pain recently. It's not clear in the documentation that you can end up running untested code.

@kopepasah
Copy link
Contributor

It is extremely common that develop branch is always in flux and, in my opinion, it is up to the user to clone and use the reference (branch|tag) of her/his choice.

In addition, it is not always true that the master branch is the latest tagged release (although it is usually stable).

I still lean towards leaving develop as the default branch.

If a user wants to clone a specific branch she/he can always append the --branch argument when cloning.

@mkjonesuk
Copy link

@kopepasah how about a warning in the README as a compromise. This section:

screenshot 2017-01-07 at 16 25 00

Doesn't make it explicit that cloning develop can lead to unstable results.

@grappler
Copy link

grappler commented Jan 7, 2017

The git clone command could include checking out the master branch instead.

So have git clone -b master git://github.com/Varying-Vagrant-Vagrants/VVV.git vagrant-local instead.

@skorasaurus
Copy link

skorasaurus commented Jan 19, 2017

Ditto with @mkjonesuk ; I had the same experience as well and am willing to write the PR as well; as I already had in vagrantvagrant - #1060

Since the Documentation for newer users is being moved to https://varyingvagrantvagrants.org/ is that being version tracked anywhere?

@jeremyfelt
Copy link
Member

We're going to address this with improved documentation for the 2.0.0 release. There should be a couple new clear indicators as to what version is being used and a prod to use the master branch if using git and not developing. The develop branch will still be the default on GitHub.

@lock
Copy link

lock bot commented Feb 22, 2020

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked and limited conversation to collaborators Feb 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

6 participants