步骤 1 – 确定要记录的 HTTP 标头
- IETF 标准中定义了许多 HTTP 标头。
- IANA 维护着一个HTTP 标头字段注册表,维基百科列出了已知的标头字段,但并非所有标头都与 Web 开发人员相关,也不是所有标头都是官方标准的一部分。
- 如果当前HTTP 标头参考总览页面上有任何红色链接,那么这些标头都是很好的记录对象。
- 如有疑问,请咨询 MDN Web Docs 团队,了解是否值得为所选标头撰写文档。
步骤 2 – 检查现有的 HTTP 标头页面
步骤 3 – 创建 HTTP 标头页面
- 所有标头页面都位于此目录下:
files/en-us/web/http/reference/headers - 要创建新页面,请参阅我们如何创建页面指南中的说明。
步骤 4 – 编写内容
- 您可以从我们的模板 HTTP 标头页面开始,或者使用您在步骤 2 中找到的现有 HTTP 标头文档之一的复制结构。这取决于您。
- 编写新的 HTTP 标头文档。
- 确保您包含以下部分:
- 导语,其中第一句话应包含标头名称(加粗)并概述其用途。
- 信息框,至少包含标头类型以及该标头是否为禁止的请求标头。
- 语法框,包含 HTTP 标头所有可能的指令/参数/值。
- 一个解释这些指令/值的章节。
- 一个示例章节,其中包含该标头的实际用例,或展示它通常在何处以及如何出现。
- 一个列出相关 RFC 标准文档的规范章节。
- 一个列出相关资源的“另请参阅”章节。
步骤 5 – 添加浏览器兼容性信息
- 如果您查看了其他 HTTP 标头页面,您会发现有一个 `{{Compat}}` 宏,它可以为您填充浏览器兼容性表格。
- 兼容性表格页面是从结构化数据生成的。如果您想为数据做出贡献,请查看 https://github.com/mdn/browser-compat-data/blob/main/README.md 上的说明,并发送一个 pull request 给我们。
步骤 6 – 更新 HTTP 标头列表
确保您的标头已列在HTTP 标头参考总览页面的相应类别下。
步骤 7 – 获取内容审核
创建标头页面后,提交一个 pull request。我们的审核团队的一名成员将被自动分配来审核您的页面。