Skip to content
This repository has been archived by the owner on Feb 16, 2020. It is now read-only.

Fix links to point current (0.2) branch instead of master branch #314

Merged
merged 1 commit into from
Jun 7, 2016

Conversation

bugron
Copy link
Contributor

@bugron bugron commented Jun 7, 2016

To keep documentation always up to date in this branch.
@askmike for future, I think it is a good idea to change your branching model. Gekko won't be 0.2 forever thus when you move to next version (hopefully, 1.0.0) these links need to be updated again to point to current renamed branch.
So my suggestion is archive master branch by renaming it something like old-gekko or whatever, then checkout new master from current 0.2 branch, rename 0.2 to staging or developement.
So the result is staging or developement branch (formerly 0.2) is where all development goes, new features, bug fixes etc., master branch (formerly latest 0.2) is where latest stable code is pushed from current development branch. So develope in staging and once code is stable, push to master.
Note, if you decide to do that now, then you'd to that before merging this PR BUT after you handle all other PRs (merge/close them), otherwise links in new master branch will point to 0.2 branch which won't exist anymore after renaming is done.

And another question. Those three PRs are open against current master branch which is obsolete. Should we close them and open new PRs against 0.2 branch?

@askmike
Copy link
Owner

askmike commented Jun 7, 2016

My goal was to phase out the existing master branch (and go forward using the current 0.2 branch under a new name) rather soon (this week or next). There are only some things that needed to be fixed before we could clean up the old master branch:

  • Make sure a number of exchanges are working (a week ago only bitstamp was working).
  • Make sure all old plugins are working (or that non working ones are documented).
  • Make sure all docs (especially regarding plugins) are up to date.
  • Make sure the new branch is stable (no memory leaks, etc.)
  • Either merge of close all opened PRs

But you are right that this transition phase could be a little cleaner.


Note, if you decide to do that now, then you'd to that before merging this PR BUT after you handle all other PRs (merge/close them), otherwise links in new master branch will point to 0.2 branch which won't exist anymore after renaming is done.

I am merging this is in now regardless since I'd rather have a consistent state (instead of half the links pointing to one branch and the other half pointing to a different one). As soon as we rename this branch to master we can fix them again.


So my suggestion is archive master branch by renaming it something like old-gekko or whatever, then checkout new master from current 0.2 branch, rename 0.2 to staging or developement.
So the result is staging or developement branch (formerly 0.2) is where all development goes, new features, bug fixes etc., master branch (formerly latest 0.2) is where latest stable code is pushed from current development branch. So develope in staging and once code is stable, push to master.

I think it's better to go forward without the branch name "master" to minimize confusion for people updating old gekko clients. What do you think of the following?

  • gekko-old (current master)
  • develop (develop branch, edge of current 0.2)
  • stable (current 0.2)

I'll see how fast I can fix the issues in the above list to rename the 0.2 branch to "stable". The last item on the list is what stopped me from renaming the current "master" branch, I am afraid what will happen to those PRs (only 2 left now).

@askmike askmike merged commit 3d7f747 into askmike:0.2 Jun 7, 2016
@bugron
Copy link
Contributor Author

bugron commented Jun 7, 2016

gekko-old (current master)
develop (develop branch, edge of current 0.2)
stable (current 0.2)

Sounds good to me.
About those two PR's. Currently I know almost nothing about trading, trading algorithms, I'm not familiar with all this so I can't QA or test #272 but I definitely want to see #218 merged.

@bugron bugron deleted the fix/link-to-current-branch branch June 8, 2016 20:52
@askmike
Copy link
Owner

askmike commented Jun 10, 2016

I now created two branches:

  • stable
  • develop

All links point to the stable branch (unless it is about something that changed in the develop branch). The 0.2 branch is now deleted.

@bugron
Copy link
Contributor Author

bugron commented Jun 10, 2016

Awesome! And develop needs to be the default branch so all PRs will be opened by default against that branch.

@askmike
Copy link
Owner

askmike commented Jun 10, 2016

I rather add that to a CONTRIBUTING.md doc (see here), mainly all Gekko users (who rather have the most stable version) want a stable version (should be the default). If you know what you are doing (eg. contributing or experimenting), try out the develop branch.

@bugron
Copy link
Contributor Author

bugron commented Jun 10, 2016

From my previous experience i know that only a small part of contributors read contribution guidelines. So lots of people were opening PRs against stable branch and I wrote a bot which points them what did they do wrong and checks if the opened PR follows repo's contribution guidelines.
Anyways, the decision is yours.

@askmike
Copy link
Owner

askmike commented Jun 10, 2016

I get a few pull requests a week max. But Gekko has over 150 downloads a week. I rather have all these people downloading the stable version.

@bugron
Copy link
Contributor Author

bugron commented Jun 10, 2016

Awesome, sound reasonable to me 👍

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

Successfully merging this pull request may close these issues.

2 participants