-
Notifications
You must be signed in to change notification settings - Fork 95
ALL ISSUES MENTIONED #26
Description
Lack of Clear Documentation
The README.md exists but needs to be reviewed for completeness. If it lacks:
Setup instructions
Dataset details
How to run the code
Citation or licensing
—> Then a pull request should add a detailed README.
No License File
A LICENSE file is missing. This makes the reuse and contribution legally ambiguous.
—> A pull request should add a LICENSE (e.g., MIT, GPL depending on intent).
No .gitignore File
Important for ignoring unnecessary files (e.g., generated images, MATLAB cache).
—> Add .gitignore for better repository hygiene.
No Directory for Results or Outputs
Output images like fusion-fight.jpg are in the root. Consider organizing into /output/ or /results/.
No Requirements or Dependency Documentation
If MATLAB toolboxes are needed, they should be listed (e.g., Image Processing Toolbox).
Script Modularity
Need to inspect main_running.m – if everything is in one script, it may need to be modularized into functions.