Fixing MDN content bugs

Note

Problems with MDN docs are reported as content repo issues (and there are still some open issues in the legacy sprints repo). This article helps you find the best issues to work on, based on your expertise and how much time you have available, and outlines the main steps to fixing them.

We get a lot of content bugs β€” any help you can give in fixing them is very much appreciated!

What do we need help with?

To help you choose what content issues to work on, we've sorted them using GitHub labels.

The labels below help you find tasks based on how much time you have available.

Label Description
10-minute tasks on the content repo
10-minute tasks on the sprints repo
A really quick task, which will probably take you 10 minutes or less.
30-minute tasks on the content repo
30-minute tasks on the sprints repo
A slightly more involved task β€” might take around 30 minutes.
1-hour tasks on the content repo
1-hour tasks on the sprints repo
A long task β€” will take an hour, or maybe even two.
multiple hour tasks on the content repo
multiple hour tasks on the sprints repo
A very in-depth task taking multiple hours to complete.

If you'd prefer to browse your tasks and choose by technology category instead, you can also find the same issues organized into project boards:

Project board Description
Learn docs MDN project board Issues concerning Learn Web Development.
Content architecture MDN project board Issues concerning general content, page architecture, and other misc tasks on MDN.
HTTP docs MDN project board Issues concerning HTTP docs
HTML docs MDN project board Issues concerning HTML docs
DevTools docs MDN project board Issues concerning Firefox DevTools docs
WebExtensions docs MDN project board Issues concerning WebExtensions docs
CSS docs MDN project board Issues concerning CSS docs
JavaScript docs MDN project board Issues concerning JavaScript docs

How can you benefit?

  • Fixing MDN content bugs is a great way to learn more about web technologies β€” as you research a problem and create the required content, you will gain a deeper understanding of the subject, and improve your skills.
  • As you get more involved in the MDN community, you'll get to know Mozilla staff and other community members, giving you a valuable network of contacts for getting help with your own issues and increasing your visibility.
  • Helping to fix problems is largely its own reward, but it will also serve as a record of your open source contributions, demonstrating your expertise in web technologies and possibly even helping you with your course, or job opportunities.

What skills do you need?

  • You need to be knowledgeable in the topic areas that you choose to help with (e.g. JavaScript, CSS).
  • Most of the examples and pages that you will help with are written in English, so you should have a reasonable understanding of the English language. But don't worry if your English is not perfect! Our team is more than happy to help clean up any writing.

How to help

  1. First of all, sign up for a GitHub account, if you don’t already have one β€” you'll need this to communicate on the GitHub issues.
  2. Next, choose one or more topic areas you’d like to help with. Use the list above to get more information to help you make your selection. If you are not sure what a good choice would be, ask for help in the MDN Web Docs chat room on Matrix

Once you are set up

  1. Choose an issue to work on that interests you, and ask us to assign it to you with a comment on the issue.
  2. If you need any help when you are working on it, feel free to contact us in the MDN Web Docs chat room on Matrix.
  3. Once you've fixed an issue, ask the submitter for a review and, hopefully, they will tell you whether they think more work is required. We will get involved if needed.
  4. Once the issue is verified fixed, it can be closed. The person closing the issue can be either the original issue submitter, or an MDN staff member.

Note: When choosing and working on an issue, you might also find our GitHub best practices and Getting started on MDN guides useful.