DSCKGEC / DSCKGEC/Health-Tracker-App

Organization and Documentation of the code

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
documentation Easy enhancement good first issue KSoC'22
Dominant language
Makefile
Stars
18
Forks
19
PR merge metrics
No merged PRs in 30d

Description

We need proper documentation and organization of the code so that it can be easily understood by newcomers. Make sure that the tasks are executed within functions and comment on how they are working, This is quite a tedious thing to do as you have to go through the whole codebase line by line, but you will learn a lot through this process.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named; start by reviewing the repository codebase to identify the tasks and areas needing documentation. Done means the relevant tasks are organized into functions and the code includes comments explaining how they work.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, dart, flutter, sqlite
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.