Add comments to source code and document overall app structure #48

Open
opened 2019-05-22 18:30:30 +00:00 by mrc-g · 2 comments
mrc-g commented 2019-05-22 18:30:30 +00:00 (Migrated from gitlab.com)

Source code is quite cleanly written and legible. Nonetheless:

  • The file structure lacks a good description of what does what
  • There are very few comments in the source code that allow a new dev to understand or interpret the function of different methods etc.
  • This is a bit of a barrier to rolling one's sleeves up and getting involved.

I think this is a great little app. Could benefit from a few people making minor improvements if the code were more legible. That way you don't need to use up your probably limited time on the small stuff.

Source code is quite cleanly written and legible. Nonetheless: - The file structure lacks a good description of what does what - There are very few comments in the source code that allow a new dev to understand or interpret the function of different methods etc. - This is a bit of a barrier to rolling one's sleeves up and getting involved. I think this is a great little app. Could benefit from a few people making minor improvements if the code were more legible. That way you don't need to use up your probably limited time on the small stuff.
tslocum commented 2019-05-22 23:29:44 +00:00 (Migrated from gitlab.com)

changed title from {-Source Code doesn't lend itself to collaborative work-} to {+Add comments to source code and document overall app structure+}

changed title from **{-Source Code doesn't lend itself to collaborative work-}** to **{+Add comments to source code and document overall app structure+}**
tslocum commented 2020-01-22 15:18:11 +00:00 (Migrated from gitlab.com)

changed milestone to %7

changed milestone to %7
tslocum added the
enhancement
label 2021-05-12 17:35:36 +00:00
tslocum added this to the 1.6.8 milestone 2021-05-12 17:43:58 +00:00
Sign in to join this conversation.
No Milestone
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tslocum/meditationassistant#48
No description provided.