Help with GIT contributions

[barsk]

Hi!
I have been working with some minor changes to the code to add a Adafruit SH110X library for the SH1106 driver which 1.3" OLEDs tend to use. THe default 0.96" OLED uses an Adafruit SSD1306 library. The code changes are minor, a #define in Config_Definitions.h and some conditional code in SparkDisplayControl.h and .cpp.

However, I am a newbie to git, been using another source control system for decades though (Subversion). My main usage pattern for git has been to clone a git repo and then just build and install from there, never contributing back. And here in Visual Studio (new IDE for me) I just stumble on even how to sync in whatever contributions has been made to the main trunc. I want to sync my working code in Visual Code . Even here I don't get it. If I "pull" it asks me to "commit" to Staged. Why? I just want to download the latest changes. I could of course delete the whole project and clone from scratch, but that seems stupid. Reading the tutorial parts for source control in Viusual Studio does not relly focus on the fundamentals that seems to elude me. Especially they focus on being the owner of the official repo, not just a "user" that wants to download changes. Any hints, pointers to external instructiones etc to get me on the right path?

As the tool instructed me strongly to "commit changes" and as that seemed to be to a "local" repository I went and did that. The changes then seems to be committed to the actual source control tree, even into main! I did not anticipate that! Although looking in the official repo in github nothing has changed. Maybe because I did not "sync" yet?

As you can see, I'm a bit lost here. Did I do something wrong? How do I correctly go about downloading the changes from the latest github sources? How do I correctly go about the process of making a "pull request" with my contributed parts?

[stangreg]

Hi, I will check and let you know when I am available again, latest in a few days.

[stangreg]

@barsk I think it is worth if you check the following sites for more info on how GitHub works. The first link will show you how you can keep your cloned repository up to date from remote changes, the second one will show you how to create a pull request. Basically you need to create a fork first, then you can create a pull request to get the changes into the main repo.

Before you submit your changes, please make sure that they will not break any existing functionality, e.g. with other displays, boards, or setups.

Get general updates from remote after cloning: https://docs.github.com/en/get-started/using-git/getting-changes-from-a-remote-repository

Creating a pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

[barsk]

Ah great. That gave me the headstart I needed. The main problem was actually the "help" from within Visual Studio that introduced some new concepts like "sync", which is not even a part of the git commands. The internal help texts in VS and git integration and the proposed workflow (unexplained) was a bit confusing. I've got the concepts understood now and have all updates up to 1.7.7 merged on my local repo. My code updates are merging perfectly with the main code, and all looks well.

I will look into updating the Readme as well for the #defines that control the two contributions which are SH1106 OLED driver support and using 4 extra GPIOs for the optional dedicated Preset slot LEDs. The latter one if activated will also make the FX LEDs active all the time and disable the (now redundant) FX symbols in the OLED display, exchanging them for an inverted bottom line showing instead the mode that is active. One of: Preset|FX Manual|Loop Config|Loop Cntrl. I also removed the full display inversion for FX mode if the alternate mode is defined.

The extra four (optional) LEDs will need to be mentioned and I'll do that in the readme if Ok with you. It is supported in my revised 3D printed case by some extra sockets. They will need to be soldered directly on the bare pins if the ESP32 board (GPIO 0, 4, 12, and 15) with a restor in series with the LED, if the current PCB is used. I will make the 3D case available on Thingiverse and similar. An easy print and surprisingly sturdy. Credits to @intaker for the basis of this!

Hope you like the the contributions.

Thanks for all the help and the great project you have created here
Kristian