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

Task: make alpha the default branch #41

Closed
kbahey opened this issue Aug 7, 2019 · 9 comments
Closed

Task: make alpha the default branch #41

kbahey opened this issue Aug 7, 2019 · 9 comments

Comments

@kbahey
Copy link

kbahey commented Aug 7, 2019

When I first came to this project, I downloaded the master branch, simply because it is the default one.

Upon encountering errors, and opening an issue, I was instructed to use the alpha branch.

In order to avoid user confusion, and reduce the support load on the dev team, please make alpha the default branch on Github.

@deufrai
Copy link
Collaborator

deufrai commented Aug 7, 2019

I'd rather release a first stable version very soon
That would imply

  • merge alpha to master ( with datastore.VERSION updated to v0.1)
  • tag that merge as v0.1
  • fast-forward the develop branch to master
  • update datastore.VERSION to v0.2-dev on develop
  • continue our next development effort on the develop branch and let alpha die after some time

I humbly volunteer for the first 4 steps above

Doing so would match the usual process of having the latest release on master branch

@kbahey
Copy link
Author

kbahey commented Aug 7, 2019

I don't mind whichever process the devs agree upon, provided it makes the default page on Github work, rather than finding out that this is not the branch that should be used (like I found out the hard way).

The present alpha branch works for me, but only when I used venv. Otherwise, there were issues caused by dependencies.

I have created a pull request with modifications to the README.md file to make venv the preferred method (since it will be the least problematic for users).

If you merge that into alpha, then do what you said above, then make v0.1 the default on the Github project page, users will get the advocated 'stable' (or 'released') version.

@deufrai
Copy link
Collaborator

deufrai commented Sep 19, 2019

Hi again
We managed to identify 5 past milestones and have properly released them. master branch is now our stable reference. v0.5 has been put there a few days ago.

alpha branch has been deleted, as we are coming closer to a regular dev/release workflow

So I'm closing this issue and encourage you to check what the next release ( version 0.6 currently developed on the 'develop' branch) will look like.

We expect to see v0.6 to be released in 2 weeks tops. The repo's default branch will then have all needed info for proper ALS install / use.

Thanks for your time and efforts

@deufrai deufrai closed this as completed Sep 19, 2019
@kbahey
Copy link
Author

kbahey commented Sep 22, 2019

I think my point was missed: when someone goes to /gehelem/als, they end up on the master branch, they download/clone it, and then it does not work.

So, whatever branch that is a) known to be working and b) continually maintained with care not to break, should be the branch that the project should default to when someone lands on the above URL.

@deufrai
Copy link
Collaborator

deufrai commented Sep 22, 2019

I See your point, @kbahey
I'll amend the README on develop branch to make it clear that this is a "bleeding edge" branch, and we can then switch the default branch to where install and usage docs are up to date and provide an easy way to try ALS out

'develop' is a dev branch, but we keep is as crash/bug free as possible. Some syntax / lint and other checks are done on Travis to help us on that

Thanks again

@kbahey
Copy link
Author

kbahey commented Sep 22, 2019

If develop is the 'usable' branch, then /gehelem/als should default to the develop branch too. That way when someone lands on the github page for the project, the clone/download link will give them a usable snapshot.

@deufrai
Copy link
Collaborator

deufrai commented Sep 24, 2019

Default branch is now 'develop'.
latest developments are there. Quite stable, with completed README

@gnthibault
Copy link
Collaborator

Thank you @deufrai for all this work !

@kbahey
Copy link
Author

kbahey commented Sep 25, 2019

Excellent! That gives people something working from what they land on.

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

No branches or pull requests

3 participants