Ayushparikh-code / Ayushparikh-code/Web-dev-mini-projects

Improve README.md clarity for Web-dev-mini-projects

Open
#949 1 comment 0 reactions 0 assignees View on GitHub
LGMSOC21
Dominant language
HTML
Stars
4.5k
Forks
1.7k
PR merge metrics
No merged PRs in 30d

Description

The current README lists projects and has basic contribution instructions, but it could be more beginner-friendly with clearer examples and visuals.

## Suggestions
1. **Add a sample project folder structure**
- Show how a typical project folder should look:
```
my-project/
├─ index.html
├─ style.css
├─ script.js
└─ README.md
```

2. **Include screenshots or GIFs**
- Visuals can help beginners understand folder structure and how projects appear in the list.

3. **Clarify contribution process briefly**
- Summarize steps from fork → add project → PR in one small section for easier reading.

Enhancing the README will make it more welcoming for first-time contributors and improve engagement.

---

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.