Hardhat-Enterprises / Deakin-Detonator-Toolkit

Deakin Detonator Toolkit redesign using Tauri, React and Mantine.
11 stars 19 forks source link

609 bug fix baseline snmpcheck #666

Closed CAfitech closed 2 months ago

CAfitech commented 2 months ago

Bugs/Issues:

Interfaces did not have appropriate docstring. The FormValuesType interface was located inside the main component. Every function did not have appropriate docstring. Every React hook did not have an appropriate inline comment. Every component constants did not have appropriate inline comments. The title consisted of more than the tools name. The description was overly lengthy and wasn't just from the source documentation. The steps were included in the description instead of separately. The steps were not included or formatted. The sourceLink was not included. The tutorial was not included in the code. The dependencies were not included. The form did not have clear defined comments. useEffect was not incorporated in the code. All of the dependencies components were not installed. Handle Process Data was not incorporated in the code. Handle Process Termination was not incorporated in the code. The onSubmit function did not have clear defined comments and docstring The clearOutput was not clearly defined. The outputV2 was not defined neither incorporated in the code. The Render component was not incorporated. Fixes:

Added all Interfaces with appropriate docstring. Moved the FormValuesType interface so its located outside the main component. Modified all the functions to have appropriate docstring. Modified so that all React hook have appropriate in line comments. Modified so that all component constants have appropriate in line comments. Modified the title to only include the name of the tool. Modified the description to be concise and accurate as per the checklist. Modified the code by adding the steps which are those only applicable to the feature. Modified the steps to properly format them. Modified to add the sourceLink containing the link to the source component. Modified to add the tutorial with an empty string. Modified to add the dependencies with the required packages for the tool. Modified so that the form is clearly defined including comments. Modified to incorporate the useEffect, clearly defining including comments. Modified to install the dependencies required. Modified to incorporate Handle Process Data with clearly defined docstring and comments Modified to incorporate Handle Process Termination with clearly defined docstring and comments Modified the onSubmit function to include clearly defined docstrings and comments Modified to incorporate the outputV2 clearly defined and in use. Modified to include the Render Component within the return of the component function.

CAfitech commented 2 months ago

Ready for review