solitontech / SLL-Toolkit

Collection of LabVIEW Reusables.
MIT License
10 stars 5 forks source link

Add LabVIEW Code Compare Tool For Git #11

Closed SatheeshvarmaSJ closed 7 months ago

SatheeshvarmaSJ commented 7 months ago

Added LabVIEW Code Compare Tool For Git. Instructions and other details to use this tool are available in the front panel of the VI.

Updated the Readme and build spec to consider this tool.

Reviewer's Checklist:

KarthikAbiram commented 7 months ago

image

  1. Recommend to add a heading called 'Credits' below the About text for mentioning about Git API
  2. Instead of 'This tool includes..', it needs to be 'This tool uses..'
  3. Below the About text and above the credits section, we can include (c) Soliton Technologies.

Few Long Term/Software Best Practice Suggestions for later:

  1. The main cluster has all elements flat. It would be good to organize them under subclusters for better devX and maintainability.
  2. Would it better to make all UI visibility, enable/disable, UI updates to be in 3 separate cases and avoid doing this inside other cases?
  3. Currently all the business logic is present in a single VI as a GUI. It would be helpful to split the core functionalities into APIs, which can then be called in a GUI. In this way, if someone wants to make changes or wants to implement a different user case, they can do so.
SatheeshvarmaSJ commented 7 months ago

Will create an issue for the tool's improvements.

Will the updated About page below is fine? Added the copyright to the VI description as well. image