AOSSIE-Org / Resonate

Clubhouse, but Open Source. A social voice platform.
GNU General Public License v3.0
188 stars 132 forks source link

Document the code to improve code readability #276

Closed bhawesh2002 closed 6 months ago

bhawesh2002 commented 7 months ago

Description

Document the code to make it easier for developers to understand the purpose, functionality, and usage of different parts of the codebase.

Fixes # (issue) [DOC: Document the code so that newer developers are easily able to understand the code] (https://github.com/AOSSIE-Org/Resonate/issues/275)

Type of change

Document the code and refactor the code.

How Has This Been Tested?

Since documentation and refactoring does not change the functionality of code, so no testing is required. But I am using Android Emulator(API 31) for testing.

Checklist:

Maintainer Checklist