CCNITSilchar / CCNITSilchar/Coding-Club-Contribution-Tracker-and-Leaderboard

Structure of project and readme

Open
#2 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
6
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Create a proper readme for anyone interested to be able to understand the project and its flow.

Structure the files properly. There are so many files in root which looks cluttered. Put utilities and classes in directories, leaving only important and config in root.

Document well the files with few comments.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the repository root, then identify the utilities and classes that should be grouped into directories. Read the existing project files and trace the project flow before defining the structure. Done means a clear README, an organized root, and useful comments throughout the files.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Refactor
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.