diff --git a/IMPROVEMENTS.md b/IMPROVEMENTS.md new file mode 100644 index 000000000..8836b719d --- /dev/null +++ b/IMPROVEMENTS.md @@ -0,0 +1,24 @@ +Improvements suggested by @sharkello + +Summary +------- +Small, high‑impact changes to improve discoverability, onboarding, and first‑time contributor experience for the "chrome-devtools-mcp" repository. + +Top items +--------- +- Add a short TL;DR at the top of README with a one‑line quickstart (try in <5 minutes). +- Provide a copy‑paste Getting Started (docker / single command / minimal example). +- Add 1–3 small examples in an folder showing the most common use cases. +- Add a template and 3 ready‑to‑assign small tasks to attract contributors. +- Add CONTRIBUTING.md, CODE_OF_CONDUCT.md (short), and PR/Issue templates. +- Add a lightweight CI workflow (syntax check / build) and a badge in README. + +Suggested "Good first issues" +----------------------------- +- "Add a minimal quickstart example" — add with copy‑paste commands. Labels: , . +- "Add CI badge" — enable a minimal GitHub Actions workflow and insert the badge into README. Labels: , . +- "Polish README TL;DR" — shorten top of README to 3 lines and add a one‑command try it. Labels: , . + +Notes +----- +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