Skip to content

Default Branch is Development, no notice in the README #977

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

Closed
GABeech opened this issue Apr 25, 2018 · 2 comments
Closed

Default Branch is Development, no notice in the README #977

GABeech opened this issue Apr 25, 2018 · 2 comments

Comments

@GABeech
Copy link

GABeech commented Apr 25, 2018

The current default branch on the repository is development which can cause confusion due to the documentation being contained in the README for that branch.

Since the GitHub UI doesn't expose this very well, can we get a notice at the top of the README that this is the documentation for vNext with a link to the master branch?

I only noticed this when I was trying to find out why the commands (i.e. -fix) where missing from the install of version 1.16.1 of the module.

@bergmeister
Copy link
Collaborator

@GABeech This is a known issue and when I looked into, it was not possible to configure GitHub to display master by default.
Also, we were expecting a release soon and therefore did not want to make it too complex. The release is imminent, which will resolve this problem soon. Should we change the parameters again, then we will display the syntax of the release and latest development version.
Going forward it would probably be better to have some of the readme also integrated into the PowerShell help so that GitHub does not provide more help than what we ship.
I am sorry for the inconvenience though.

@bergmeister
Copy link
Collaborator

The default branch is now master for a simplified workflow and to be consistent with other PS repositories.
I submitted a PR to the vs code extension to update the PSSA docs link to go to master, which will likely be in the next update of the extension: PowerShell/vscode-powershell#2037
We will still leave the old branch there for legacy reasons but this means you probably want to update your default branch in your fork to master: https://help.github.com/en/articles/setting-the-default-branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants