Skip to content
New issue

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

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

Already on GitHub? # to your account

Docs should be consistent across branches #89

Open
pauljickling opened this issue Oct 15, 2018 · 3 comments
Open

Docs should be consistent across branches #89

pauljickling opened this issue Oct 15, 2018 · 3 comments

Comments

@pauljickling
Copy link
Collaborator

One side effect of having put considerable work into the dev branch without merging into master is the docs in the master branch have diverged from the dev branch. This makes things confusing for newcomers to the project. It is not reasonable to have to switch to a different branch to read documentation about a repository.

@themightychris
Copy link

You might just switch the default GitHub branch to dev, there's a case to be made that it's where developers should be starting if you have one

@pauljickling
Copy link
Collaborator Author

I like that solution since it resolves the issue with the least amount of changes that need to be made. :-)

@themightychris
Copy link

Yeah it's what I do for all my repos and there's been no downside. Master might be what's best to deploy but you pretty much always want people browsing on GitHub or cloning the repo starting on dev

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

No branches or pull requests

2 participants