Skip to content

Commit fdfa531

Browse files
committed
Add IMPROVEMENTS.md: onboarding suggestions by @sharkello
1 parent 0a6aaa5 commit fdfa531

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

IMPROVEMENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Improvements suggested by @sharkello
2+
3+
Summary
4+
-------
5+
Small, high‑impact changes to improve discoverability, onboarding, and first‑time contributor experience for the "chrome-devtools-mcp" repository.
6+
7+
Top items
8+
---------
9+
- Add a short TL;DR at the top of README with a one‑line quickstart (try in <5 minutes).
10+
- Provide a copy‑paste Getting Started (docker / single command / minimal example).
11+
- Add 1–3 small examples in an folder showing the most common use cases.
12+
- Add a template and 3 ready‑to‑assign small tasks to attract contributors.
13+
- Add CONTRIBUTING.md, CODE_OF_CONDUCT.md (short), and PR/Issue templates.
14+
- Add a lightweight CI workflow (syntax check / build) and a badge in README.
15+
16+
Suggested "Good first issues"
17+
-----------------------------
18+
- "Add a minimal quickstart example" — add with copy‑paste commands. Labels: , .
19+
- "Add CI badge" — enable a minimal GitHub Actions workflow and insert the badge into README. Labels: , .
20+
- "Polish README TL;DR" — shorten top of README to 3 lines and add a one‑command try it. Labels: , .
21+
22+
Notes
23+
-----
24+
I can prepare the example files and open a PR with these changes if you want. For now I've created this IMPROVEMENTS.md and a branch: sharkello/improve-readme-20260417

0 commit comments

Comments
 (0)