artofscience / SAOR

Sequential Approximate Optimization Repository
GNU General Public License v3.0
5 stars 1 forks source link

Proposal: merge all into main and next steps to review the code #9

Closed MaxvdKolk closed 3 years ago

MaxvdKolk commented 3 years ago

I will attempt to merge most code in its current state into the dev branch. As there is currently a lot of code staged in these branches---much more than can be easily reviewed/updated---before/during merging, my proposal would be to simply merge it all into dev without much reorganisation.

My proposal would then be to do the following with the currently present code before adding much more:

Once we are all OK on the current version in main, we can start to slowly add additional test problems?

Any thoughts @aatmdelissen @Giannis1993 @artofscience?

Giannis1993 commented 3 years ago

Agree! My initial idea was to branch from dev and keep main more stable. Only after merging our dev-feature branches into dev we would merge dev into main (e.g. once per month). But definitely we need a starting branch since it has become quite messy.

MaxvdKolk commented 3 years ago

Yeah, that also makes sense. We might opt now to place it all in dev rather than what I proposed, and iterate on that branch. Once we are all kind of happy about the interfaces, lets merge it then into main as the first "real" baseline version. From that moment on, we can then either make branches that go directly into main for smaller features and work in dev for some large extensions.

In that way we could also do your approach, with monthly updates from dev to main for introducing bigger features/changes.

MaxvdKolk commented 3 years ago

Both #5 and #3 are now merged in to dev. I will add some issues based on current comments. Lets go from there.

MaxvdKolk commented 3 years ago

Added some issues that came to mind looking through the code. I would invite you to do the same and add issues to whatever pieces of code that could (or should :p) be changed. Lets try to fix some of those issues and finalise an initial version of the API doing so.

Once we have that, lets merge it all into main and see how we go from there.

Giannis1993 commented 3 years ago

Done!