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

Improve CONTRIBUTING.md for Web-dev-mini-projects

Open
#950 2 comments 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 CONTRIBUTING.md explains how to contribute, but it could benefit from examples and a step-by-step checklist for beginners.

## Suggestions
1. **Add a sample project folder structure**
- Include `index.html`, `style.css`, `script.js`, and `README.md`.

2. **Clarify branch naming and PR process**
- Give an example branch name and a simple PR title template.

3. **Add a checklist for first-time contributors**
- Fork → Clone → Add Project → Test → Commit → Push → PR

4. **Optional: Visuals**
- Screenshots or GIFs can guide beginners on how to structure files.

Improving the CONTRIBUTING.md will make it easier for new contributors to follow and increase 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.