Contributing to MDN
MDN Web Docs needs your help! We have a large number of typos to fix, examples to write, bugs to fix, people to talk to, and more, and the number is growing as more people start using the site. This page outlines what you can do to help.
Note: If you haven't contributed to MDN previously, the Getting Started guide explains the process in four simple steps. Good news, you're already on step 2: "Picking a task to complete."!
What can I do to help?
There are multiple avenues you can take to contribute to MDN depending on your skillset and interests. Along with each task we provide a short description and an approximate time that each type of task typically takes.
If you are not sure what to do, you are always welcome to ask for help.
Primary contribution types
The links in this section lead to detailed guides explaining how to do a particular contribution task that we are most interested in getting community help with, either because they are a critical function, and/or because they have a large backlog associated with them. Please consider helping out with these tasks before you consider contributing in other ways.
Tasks | Description | Skillset required |
---|---|---|
Fixing MDN content bugs | Our content repo is where people submit issues to report problems found with MDN docs. We get a lot of content bugs, and any help you can give in fixing them would be much appreciated. |
|
Reviewing MDN edits | People submit pull requests on our content repo all the time to update MDN content, and we need help reviewing them. Head over to our REVIEWING.md page to find out how the reviewing process works, and how you can get involved. |
|
Help beginners to learn on MDN | Our Learn web development pages get over a million views per month and have active forums where people go to ask for general help, or request that their assessments be marked. We'd love some help with answering posts and growing our learning community. |
|
We will add more tasks here as time goes on.
Priority ratings
You can also look at priority ratings to give you an idea of what the most important work is to work on — we've started giving content bug issues labels of P0, P1, P2, P3, and P4 to signify how important they are, with lower numbers being more important than higher numbers.
These are figured out during the regular MDN bug triage process, based on the MDN documentation priority list.
Other task types
If our main priorities listed above don't interest you, you can find a number of other, more general task types to get involved with below, split up by skillset.
If you are more interested in words, you could do the following:
- Update an existing article with new information (5 minutes-1 hour)
- Write a new entry in the Glossary (15 minutes-1 hour)
If you are more interested in code, you could try your hand at the following:
- Convert code samples to be "live" (30 minutes)
- Send a code patch to the Yari codebase (1 hour)
- Write an interactive example (1 hour)
If you are interested in words and code, you could try your hand at the following:
- Write or update an API reference (30 minutes to 2 hours, or more)
- Write a new article on a topic you are familiar with (1 hour or more)
- Add or update browser compatibility data on a reference page (30 minutes to 1 hour)
Note: If you have found something that is incorrect on MDN but you're not sure how to fix it, you can report problems by filing a documentation issue. Please give the issue a descriptive title. (It's not helpful to say "Dead link" without saying where you found the link).
Other useful pages
- Documentation processes
The MDN documentation project is enormous; there are a vast number of technologies we cover through the assistance of hundreds of contributors from across the world. To help us bring order to chaos, we have standard processes to follow when working on specific documentation-related tasks. Here you'll find guides to those processes.
- MDN contribution changelog
This document provides a record of MDN content processes, constructs, and best practices that have changed, and when they changed. It is useful to allow regular contributors to check in and see what has changed about the process of creating content for MDN.
- MDN web docs: How-to guides
These articles provide step-by-step guides to accomplishing specific goals when contributing to MDN.