Descriptions of repository branches

[samiebee43]

sbee-dev:
Even with main +
Plan for 2023-06-28T931UTC-4:

1. merge sbee-dev <-- sbee-persist-gain ✅
2. patch file GainDBFeature.py from sbee-stage-pc-gain ✅
3. cherry-pick 2e50fa6 OR manually reapply GainDBFeature instantiation update ✅
4. cherry-pick 7759066 (fixes Invalid path shown next to Save .ini button #183) ✅

Then sbee-dev will have updates related to Gain without updates related to Plugins:

• GainDBFeature deep refactor from sbee-refactor
• Quick fix to Invalid path shown next to Save .ini button #183

sbee-stage-pc-gain:

• GainDBFeature deep refactor from sbee-refactor
• PluginController refactor from sbee-min-refactor
• Quick fix to Invalid path shown next to Save .ini button #183
• Partial integration of PluginController refactor

sbee-persist-gain:

• Contains GainDBFeature, serial number specific - not including sbee-refactor

ubu-py37:

• Contains compatibility changes specific to Ubuntu build. Do not merge to main.

sbee-baseline:

• Contains work in progress for LocalBaseline: Multiplex
• Might have some significant changes to PluginController

sbee-min-refactor:

• Contains a 'deep refactor' of only PluginController, a little bit stale
• Attempted to reconsolidate in sbee-dev

sbee-refactor:

• Has a 'deep refactor' of (almost?) every class in BusinessObjects.
• Not trusting enough to PR, but can be used to acquire starting points when moving towards self.ctl

[samiebee43]

Git has a feature for adding descriptions to branches--planning to move these there.

[samiebee43]

While git lets use add branch descriptions using git branch --edit-description, it's quite hidden and doesn't have rich text support, so actually I rather still use this space for that.

On 2023 Oct 11, I've pruned a lot of my merged branches. Deleting the branch after merge had been missing from my workflow for a while now. Keeping things tidy is the first step to making a robust repository. Here is the latest update about the meaning of my branches.

Enlighten currently has 15 branches (not counting main). Five of them are mine.

Contrary to it's name, this branch actually _removes_ the FWHM functionality from Local Baseline. The feature is on main, and I believe it is both unstable and non-critical, making it a perfect candidate for removal. More info in today's pull request: #316 . Ideally that PR will be merged and this branch will be deleted by the end of the week. This branch is like a tag. It took a release of Enlighten (I think 4.0.12) and applied some changes to make it work on Ubuntu. I think one resolution would be to tag the branch then remove it. Be sure to remain compatible with enlighten_ubuntu_launcher! This branch is never meant to be merged to main. Think of it as a downstream release. These three branches signify varying levels of invasiveness attempts to refactor the codebase. Notice from the GH's estimation of how many commits ahead each branch is. sbee-refactor has the most changes and sbee-min-refactor has the least. I'm not comfortable to merge these to main because they involve sweeping changes that were performed using automatic tools and without much testing. They may work as starting points for future refactoring, preferably by checking out a single file at time, for a more cautious and test-centric rewriting. Completely removing the refactoring branches would not be the end of the world. What remains important to me is the underlying motive of (1) using a single context variable ctl, (2) unifying Controller and BusinessObjects, (3) only having one README for the repository--all else moved to Wiki, (4) Redoing the plugin system using a functional paradigm.