Fixing MDN content bugs - The MDN project 编辑
Our content repo is where people submit issues to report problems found with MDN docs (You'll also find a lot of content bugs still to fix in the older sprints repo, which will eventually be shut down). We get a lot of content bugs, and any help you can give in fixing them would be much appreciated.
What do we need help with?
To help you choose what content issues to work on, we've split them up using GitHub labels into different timings so you'll be able to find something to work on in the 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
- 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.
- Sign up for an MDN account, if you don’t already have one, as explained in Create an account on MDN. You can authenticate it using your GitHub account, and you'll need this to update MDN content as required to fix the issues you sign up for.
- 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
- Choose an issue to work on that interests you, and ask us to assign it to you with a comment on the issue.
- 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.
- 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.
- 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 find our GitHub best practices useful.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论