-
Notifications
You must be signed in to change notification settings - Fork 55
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
Make version_0_2
the default branch and rename master
to version_0_3
#248
Comments
Perhaps the branch name should include 'dev' in it? I know this then means the branch name might have to be effectively changed later, but it may pre-empt some additional misunderstandings about the state of the branch code. |
I would always consider that the The The main issue here is users being confused by the documentation. We can solve that just by making |
Reading the documentation on GitHub, it looks like it doesn't matter whether I think it's a bad idea - it's the route we'll have to take. I think that the benefits of transparent documentation for users outweigh my concerns. I think we should try to:
Am I missing anything? What do you think? |
That last comment got buried in notifications.... I don't see a great number of branches (some active ones—mostly mine—and a few stale ones). Which would you be trying to eliminate? If we do # 2 and # 3 in that order, they are easy to do. I guess the only other thing would be the not you left in #250, about the config file needed to make @allcontributors work. |
There aren't many (I deleted a handful after writing that comment). I haven't decided what to do with the others.
Unless there's something I've forgotten… there usually is. |
Many users who install
pyani
v0.2.x throughconda
orPyPI
come to GitHub for documentation, and find the default branchmaster
, which refers to v0.3+. The CLIs are different, and this causes confusion (see #240 #238 #226 #192 #176 #171 #169 #165 etc.)By making
version_0_2
the default, we present the stable version ofpyani
, and the documentation that those users expect.Renaming
master
toversion_0_3
has a number of desirable effects, including being explicit and transparent about the purpose of the branch, and setting a precedent for branch naming when developing future versions.When v0.3.0 becomes the stable version, we can make the
version_0_3
branch the default for the repo.The text was updated successfully, but these errors were encountered: