aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/mdn/contribute/index.html
blob: bc427255e15fecda90ec23012fb1e4bc49cf506b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
---
title: 为 MDN 做贡献
slug: MDN/Contribute
tags:
  - Guide
  - Landing
  - MDN Meta
translation_of: MDN/Contribute
---
<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/zh-CN/docs/MDN")}}</div>

<p>欢迎!当你来到了这里,说明你已经迈出了成为 MDN 贡献者的第一步!</p>

<p>MDN Web Docs 里面的所有内容,都是由热情的参与者们贡献的,他们来自世界各地,有着不同的身份。不过人无完人,里面也有着大量——因为参与者真的很多——等待改善的问题,比如文章的排版行文,又或者是文章内的示例和网站本身的错误等等。如果你有兴趣成为我们的一员的话,下面列出了你可以通过哪些方式帮到我们。</p>

<div class="notecard note">
  <h4>注意</h4>
  <p>目前 <a href="https://hacks.mozilla.org/2020/10/mdn-web-docs-evolves-lowdown-on-the-upcoming-new-platform/">MDN 的内容已经迁移至 GitHub </a>,之前编辑网站内容的途径已经失效。不论你之前是否参与编辑过 MDN 网站的内容,你都可以在<a href="/zh-CN/docs/MDN/Contribute/Getting_started">初识 MDN</a> 中了解新的参与方式。</p>
</div>

<h2 id="What_can_I_do_to_help">我可以做些什么?</h2>

<p>我们提供了很多种方式让你参与到 MDN 的建设,每种方式都对应着一类需要解决的问题,你可以根据你掌握的技术,或者自己的兴趣随意选择。后面还提供了一个简短的描述,希望可以帮助你更好地理解它们。</p>

<p>如果你不知道该从哪入手,我们随时欢迎你<a href="/zh-CN/docs/MDN/Contribute/Getting_started#step_4_ask_for_help">向我们寻求帮助</a></p>

<h3 id="Primary_contribution_types">需要优先解决的任务</h3>

<p>这部分内容较详细地列出了我们最关注的的问题,有的是因为关系到网站最重要的功能,有的则是因为积压了庞大的工作量,抑或是两者皆有。如果不介意的话,我们希望你能优先完成这些任务。</p>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">任务类型</th>
   <th scope="col">任务描述</th>
   <th scope="col">必备能力</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><a href="/zh-CN/docs/MDN/Contribute/Fixing_MDN_content_bugs">改正内容错误</a></td>
   <td>在 MDN 文档中被发现的一些问题会被提交到 <a href="https://github.com/mdn/content/issues">content repo</a> (你在某些内容中发现的错误可能属于<a href="https://github.com/mdn/sprints/">sprints repo</a>,这是之前的遗留内容,你大可以忽略它们)。你可以看到里面有不少问题,无论你愿意做点什么,我们都很感激。</td>
   <td>
    <ul>
     <li>对要修改的内容,你需要对内容涉及到的技术(类似 JavaScript、CSS 等)有一定的了解。</li>
     <li>基本的英语读写能力(不擅长也没关系,我们可以帮你)。</li>
    </ul>
   </td>
  </tr>
  <tr>
   <td><a href="https://github.com/mdn/content/blob/main/REVIEWING.md">审核内容修改</a></td>
   <td><a href="https://github.com/mdn/content">Content repo</a>  每时每刻都会收到人们提交的内容修改, 我们需要有人来审核它们。在 <a href="https://github.com/mdn/content/blob/main/REVIEWING.md">REVIEWING.md</a> 里介绍了我们审核工作的流程,以及如何加入进来。</td>
   <td>
    <ul>
      <li>对要修改的内容,你需要对内容涉及到的技术(类似 JavaScript、CSS 等)有一定的了解。</li>
      <li>基本的英语读写能力(不擅长也没关系,我们可以帮你)。</li>
    </ul>
   </td>
  </tr>
  <tr>
   <td><a href="/zh-CN/docs/MDN/Contribute/Help_beginners">帮助网站上的初学者</a></td>
   <td>我们的 <a href="/zh-CN/docs/Learn">Web 开发教程</a>非常热门,<a href="https://discourse.mozilla.org/c/mdn/learn/250">论坛上</a>也有许多初来乍到的爱好者,他们有很多疑问等待有经验的人帮助他们解决。</td>
   <td>
    <ul>
      <li>对要修改的内容,你需要对内容涉及到的技术(类似 JavaScript、CSS 等)有一定的了解。</li>
      <li>对帮助初学者有足够的耐心与热情。</li>
      <li>流畅的英语交流能力(当然要求也没那么严格)。</li>
    </ul>
   </td>
  </tr>
 </tbody>
</table>

<p>我们后续还会在这个表格添加更多的任务。</p>

<h4 id="priority_ratings">优先级</h4>

<p>我们使用不同的标签来区分不同等级 issue 的重要性,标签从 P0 开始重要性依次递减,数字则依次增大(P0、P1、P2……)。你也可以从这个方面着手,找到最适合你的任务。</p>

<p>不同优先级的分类标准,你可以在 <a href="/zh-CN/docs/MDN/Contribute/Documentation_priorities">MDN 文档优先级</a>找到详细的描述。</p>


<h3 id="Other_task_types">其他类型的任务</h3>

<p>如果你对上面这些较优先的任务不感兴趣,下面列出了一些其他类型的任务。这些任务一般没那么紧迫,但依然对我们有帮助。</p>

<p id="Option_1_I_like_words">如果你对文字感兴趣,下面这些任务可能适合你:</p>

<ul>
 <li><a href="/zh-CN/docs/MDN/Contribute/Howto/Create_and_edit_pages#editing_an_existing_page">为现有文章补充新的信息</a>。(需时:5 分钟到 1 小时)</li>
 <li><a href="/zh-CN/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary">在术语表里新增一个条目</a>。(需时:15 分钟到 1 小时)</li>
</ul>

<p>如果你对代码感兴趣,可以试试下面这些任务:</p>

<ul>
 <li><a href="/zh-CN/docs/MDN/Contribute/Howto/Convert_code_samples_to_be_live">让示例代码以预期的方式展示出来</a>。(需时:15 分钟到 1 小时)</li>
 <li><a href="https://github.com/mdn/yari">完善 Yari 平台</a>。(需时:1 小时)</li>
 <li><a href="https://github.com/mdn/interactive-examples/blob/master/CONTRIBUTING.md">新建一个可交互的的示例</a>。(需时:1 小时)</li>
</ul>

<p>如果你对代码和文章<em>这两者都感兴趣</em>,下面列出的任务或许适合你:</p>

<ul>
 <li><a href="/zh-CN/docs/MDN/Contribute/Howto/Write_an_API_reference">撰写新的或完善现有 API 参考</a>。(需时:30 分钟到 2 小时或更长)</li>
 <li><a href="https://github.com/mdn/content#adding-a-new-document">写一篇文章分享你熟悉的技术领域</a>。(需时:1 小时或更长)</li>
 <li><a href="/zh-CN/docs/MDN/Structures/Compatibility_tables">添加或更新参考页面列出的浏览器兼容性</a>。(需时:30 分钟到 1 小时)</li>
</ul>

<div class="notecard note">
<p><strong>注意</strong>:如果你在使用 MDN 时发现了一些错误,却不知道怎么改正,你可以<a href="https://github.com/mdn/content/issues/new/choose">提交一个 issue</a>。记得写个合适的标题(你可以在 <a href="https://github.com/mdn/content/issues">issue 列表</a>里参考一下别人的格式),并简单描述一下问题的位置和涉及到的内容,这样可以方便别人确定问题到底出在哪。如果你发现的问题属于翻译上的错误,<a href="https://github.com/mdn/translated-content/issues/new/choose">向 Translated-content Repo提交一个 issue</a> 会更加合适。</p>
</div>

<h2 id="Other_useful_pages">相关链接</h2>

<p>{{LandingPageListSubPages()}}</p>