search

designforsf / brigade-matchmaker

Prototype matchmaking service for newly arriving members.
MIT License
9 stars 12 forks source link

Docs should be consistent across branches #89

Open pauljickling opened 5 years ago

pauljickling commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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

themightychris commented 5 years ago

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