Handover to IP - Patches, comments and codebase cleanup

[tubamos]

Item type: documentation

Description:: This task is part of the code clean-up process to remove un-used codes and files and provide comments to ensure code readability and maintainability

User Story

As a software development team,
we need to complete the handover to the IP team by providing all necessary patches, comments, and cleaning up the codebase
to ensure a smooth transition and maintainability of the project.

Acceptance Criteria

• All patches applied to the codebase are documented.
• Each patch includes a detailed description of changes, reasons for the patch, and any potential impacts.
• All functions and critical code sections have clear, concise comments explaining their purpose and functionality.
• The codebase is free from unnecessary commented-out code, unused variables, and redundant files.
• A comprehensive handover document is created, including an overview of the project, major components, dependencies, and instructions for setting up the development environment.
• At least one knowledge transfer session is conducted with the IP team to walk through the codebase, patches, and documentation.

Definition of Done

• The feature has been fully implemented.
• The feature code is documented with clear explanations of its functionality and usage.
• The feature code has been reviewed and approved by at least one team member.
• The feature branches have been merged into the main branch and closed.
• The feature utility, function and usage have been documented in the respective project wiki on github.