Repository Reorganization and Cleanup

Summary

Complete reorganization of the repository to prepare it as a professional product before the generation of executables. Moved all manual test scripts to a dedicated folder, removed temporary files and debug logs, and created the official CHANGELOG.md to document version 0.0.1.

Hardware Concept

This entry is not about Game Boy hardware, but about organizing software projects. A well-structured repository makes it easier for code to be maintained, distributed, and understood by other developers.

Separating production code, automated tests, and manual development scripts is a standard practice that improves project clarity and makes it easier to generate clean distributions.

Implementation

A complete cleanup of the repository was performed following Python project organization best practices:

File reorganization

• `tests/manual_scripts/` folder:Created to contain all manual test scripts developed during development.
• Moved scripts:All scripts `test_mario*.py` and `verify_renderizado_mario.py` were moved to the new folder with paths adjusted to work from their new location.
• README in manual_scripts:Documentation was created explaining the purpose of each script.

Temporary cleaning

• Deleted logs:Removed `interrupts_test.log`, `mbc1_test_log.txt`, `test_lcdc_log.txt`.
• Verification of .gitignore:Confirmed that `*.log` and `.pytest_cache/` are correctly ignored.

Documentation

• CHANGELOG.md:Created following the Keep a Changelog format, documenting version 0.0.1 with implemented features and known issues.
• requirements.txt:Verified and kept clean with only project dependencies (pygame-ce, pytest, pytest-cov).

Design decisions

It was decided to keep the manual test scripts instead of removing them because they may be useful for future debugging and as examples of emulator usage. However, they were organized in a dedicated folder to keep the project root clean.

Affected Files

• tests/manual_scripts/- New folder created
• tests/manual_scripts/test_mario.py- Moved and adjusted
• tests/manual_scripts/test_mario_monitor.py- Moved and adjusted
• tests/manual_scripts/test_mario_ui.py- Moved and adjusted
• tests/manual_scripts/test_mario_visual.py- Moved and adjusted
• tests/manual_scripts/verify_renderizado_mario.py- Moved and adjusted
• tests/manual_scripts/README.md- Created
• CHANGELOG.md- Created
• test_mario.py- Removed (moved)
• test_mario_monitor.py- Removed (moved)
• test_mario_ui.py- Removed (moved)
• test_mario_visual.py- Removed (moved)
• verify_rendered_mario.py- Removed (moved)
• interrupts_test.log- Removed
• mbc1_test_log.txt- Removed
• test_lcdc_log.txt- Removed

Tests and Verification

The reorganization was verified as follows:

• Folder structure:Manually verified - all scripts are in `tests/manual_scripts/` and root is clean.
• Routes in scripts:All moved scripts were adjusted to use correct relative paths from their new location (using `Path(__file__).parent.parent.parent` to access the project root).
• Deleted files:Confirmed that all original logs and scripts were removed from root.
• CHANGELOG:Verified that it follows the standard format and correctly documents version 0.0.1.

Note:No automated tests were run in this step as it is a structural reorganization, not a functional change. Moved scripts maintain their original functionality.

Sources consulted

• Keep a Changelog:https://keepachangelog.com/es-ES/1.0.0/
• Semantic Versioning:https://semver.org/spec/v2.0.0.html
• Python Project Structure Best Practices (general knowledge)

Educational Integrity

Next Steps

• [ ] Generation of executables (PyInstaller or similar)
• [ ] Creation of installers for Windows/Linux/macOS
• [ ] Release preparation v0.0.1