blakeembrey/code-problems

Provide overview in README

Open

#34 opened on Jun 18, 2013

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (3,818 stars) (586 forks)batch import
help wanted

Description

(In respone to this)

Yes, by topic would be OK. Topics like: math related, working with strings, working with arrays, etc.

The lists don't have to provide links to the sub dirs of the repo. Their purpose is just to provide a general overview of what's inside the repo. Without such an overview, the visitor has to go through the list of sub dirs one-by-one which is not very effective.

So, I think an overview in the README file would make this repo significantly more user friendly.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic markdownunderstanding of repo structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the current README and list of subdirectories. Create a table of contents grouped by topic (e.g., math, strings, arrays) with links to each problem directory. Ensure the overview improves navigability without duplicating content.