Proposal: Improve README onboarding flow for first-time MDN contributors
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1.4k
- Forks
- 204
- PR merge metrics
- No merged PRs in 30d
Description
Proposal
Hi MDN team 👋,
While going through the README as a first-time contributor, I noticed that although the information is comprehensive, the onboarding flow may feel a bit overwhelming for newcomers.
I’d like to propose a README improvement focused on making it easier for first-time contributors to quickly understand:
- What MDN Web Docs is
- How they can contribute (content vs engineering vs translation)
- What the minimal setup steps are
- Where to go next after setup
Potential improvement ideas (open to discussion):
- Adding a short “Quick Start for New Contributors” section near the top
- Breaking long sections into clearer subsections
- Highlighting beginner-friendly contribution paths with links
- Minor wording tweaks for clarity (no change in meaning or policy)
I’m happy to draft a PR once there’s agreement on scope and direction.
Looking forward to your feedback, and thanks for maintaining MDN!
Browser support
No response
Tasks
Dependencies
Additional information
No response
Are you willing to support this work?
yes
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the repository README and the proposed onboarding goals in this issue. Review how contributor paths, setup steps, and next steps are currently presented, then agree on the scope before drafting a change; done means an agreed README onboarding improvement with clearer beginner paths and wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100