为你的应用撰写列表描述

以下是在草稿列表的**列表描述**部分中需要填写字段的指南。

命名和链接

清单名称

您的清单名称将显示在GitHub Marketplace 首页上。名称限制为 255 个字符，可以与您的应用名称不同。您的清单名称不能与 GitHub 上现有的帐户名称相同，除非该名称是您自己的用户或组织名称。

清单的超简描述

社区将在您的应用名称下方看到“超简”描述，位置为GitHub Marketplace 首页。

“超简描述”的长度

我们建议将简短描述控制在 40 到 80 个字符之间。尽管您可以使用更多字符，但简洁的描述更容易让客户快速阅读和理解。

“超简描述”的内容

• 描述应用的功能。不要在这个空间中使用号召性用语。例如

  请勿：用于 GitHub 问题的轻量级项目管理

  请勿：在 GitHub 上管理您的项目和问题

  提示：在号召性用语中的动词末尾添加“s”，将其转换为可接受的描述：管理您在 GitHub 上的项目和问题

• 不要在描述中重复应用的名称。

  请勿：一个容器原生持续集成工具

  请勿：Skycap 是一个容器原生持续集成工具

“超简描述”的格式

• 始终使用首字母大写。仅将第一个字母和专有名词的首字母大写。

• 不要在简短描述的末尾使用标点符号。简短描述不应包含完整的句子，绝对不应包含多个句子。

• 仅将专有名词的首字母大写。例如

  请勿：针对 Web 开发人员的一键交付自动化

  请勿：针对 Web 开发人员的一键交付自动化

• 在列表中始终使用串行逗号。

• 避免将 GitHub 社区称为“用户”。

  请勿：自动为组织中的成员创建问题

  请勿：自动为组织的用户创建问题

• 避免使用缩略词，除非它们已广为人知（例如 API）。例如

  请勿：敏捷任务板、估算和报告，无需离开 GitHub

  请勿：敏捷任务板、估算和报告，无需离开 GitHub 的 UI

类别

GitHub Marketplace 中的应用可以按类别显示。在**主要类别**下拉列表中选择最能描述应用主要功能的类别，并可选择选择一个适合您应用的**次要类别**。

支持的语言

如果您的应用仅适用于特定语言，请选择您的应用支持的多达 10 种编程语言。这些语言将显示在您的应用的 GitHub Marketplace 列表页面上。此字段为可选字段。

清单 URL

必需的 URL

• 客户支持 URL：客户在遇到技术支持、产品或帐户查询时将访问的网页的 URL。
• 隐私政策 URL：显示您的应用隐私政策的网页。
• 安装 URL：此字段仅显示在 OAuth 应用中。（GitHub 应用不使用此 URL，因为它们改为使用 GitHub 应用设置页面中的可选设置 URL。）当客户购买您的 OAuth 应用时，GitHub 将在他们安装应用后将客户重定向到安装 URL。您需要将客户重定向到https://github.com/login/oauth/authorize以开始 OAuth 授权流程。有关更多详细信息，请参阅“处理新购买和免费试用”。如果您列出的是 GitHub 应用，请跳过此字段。

可选 URL

• 公司 URL：指向您公司网站的链接。
• 状态 URL：指向显示应用状态的网页的链接。状态页面可以包含当前和历史事件报告、Web 应用正常运行时间状态以及计划的维护。
• 文档 URL：指向教导客户如何使用您的应用的文档的链接。

徽标和功能卡片

GitHub Marketplace 会在圆形徽章内显示所有清单的方形徽标图像，以直观地区分应用。

功能卡片包含您的应用的徽标、名称以及捕捉您的品牌个性的自定义背景图像。如果您的应用是首页顶部四个随机推荐应用之一，GitHub Marketplace 将显示此卡片。每个应用的超简描述都显示在其功能卡片下方。

在您上传图像并选择颜色时，您的 GitHub Marketplace 草稿清单将显示徽标和功能卡片的预览。

徽标指南

您必须上传自定义徽标图像。对于徽章，请选择背景颜色。

• 上传至少 200 像素 x 200 像素的徽标图像，这样在发布清单时就不需要对徽标进行放大。
• 徽标将被裁剪成正方形。我们建议上传一个正方形图像文件，并将您的徽标放在中心。
• 为了获得最佳效果，请上传具有透明背景的徽标图像。
• 为了使徽章看起来无缝，请选择与徽标图像的背景颜色（或透明度）匹配的徽章背景颜色。
• 避免使用包含单词或文本的徽标图像。包含文本的徽标在小屏幕上缩放效果不佳。

功能卡片指南

您必须为功能卡片上传自定义背景图像。对于应用的名称，请选择文本颜色。

• 在背景图像中使用图案或纹理，以使您的卡片具有视觉识别性，并有助于使其在 GitHub Marketplace 首页的深色背景下脱颖而出。功能卡片应捕捉您的应用的品牌个性。
• 背景图像尺寸为 965 像素 x 482 像素（宽度 x 高度）。
• 为应用的名称选择一种在背景图像上清晰显示的文本颜色。

清单详情

要访问您的应用的登录页面，请从 GitHub Marketplace 首页或类别页面点击您的应用名称。登录页面显示应用的较长描述，其中包括两部分：“简介”和“详细描述”。

您的“简介”将显示在应用的 GitHub Marketplace 登录页面顶部。

点击**阅读更多...**，将显示“详细描述”。

请遵循以下指南编写这些描述。

“简介”和“详细描述”的长度

我们建议在列出您的应用时，在必需的“简介”字段中编写一个 1-2 句的高级摘要，字数在 150-250 个字符之间。尽管您可以使用更多字符，但简洁的摘要更容易让客户快速阅读和理解。

您可以在可选的“详细描述”字段中添加更多信息。在应用登录页面上的简介下方点击**阅读更多...**后，您可以看到此描述。详细描述由 3-5 个价值主张组成，每个价值主张用 1-2 句进行描述。您可以为此描述使用多达 1,000 个字符。

“简介”和“详细描述”的内容

• 简介始终以应用的名称开头。

• 始终使用主动语态编写描述和价值主张。

“简介”和“详细描述”的格式

• 在价值主张标题中始终使用首字母大写。仅将第一个字母和专有名词的首字母大写。

• 在描述中使用句号。避免使用感叹号。

• 不要在价值主张标题的末尾使用标点符号。价值主张标题不应包含完整的句子，也不应包含多个句子。

• 对于每个价值主张，都应包含一个标题，后跟一段描述。使用 Markdown 将标题格式化为三级标题。例如

学习您需要的技能

GitHub Skills 可以帮助您学习如何使用 GitHub、使用 Markdown 更有效地进行沟通、处理合并冲突等等。

• 仅将专有名词的首字母大写。

• 在列表中始终使用串行逗号。

• 避免将 GitHub 社区称为“用户”。

  请勿：自动为组织中的成员创建问题

  请勿：自动为组织的用户创建问题

• 避免使用缩略词，除非它们已广为人知（例如 API）。

产品屏幕截图

您可以上传多达五个应用的屏幕截图图像，以在应用的登录页面上显示。为每个屏幕截图添加可选标题以提供上下文。上传屏幕截图后，您可以将它们拖动到您希望在登录页面上显示的顺序。

屏幕截图指南

• 图像必须是高分辨率（至少 1200px 宽）。
• 所有图像必须具有相同的高度和宽度（纵横比），以避免人们从一个图像点击到另一个图像时出现页面跳动。
• 尽可能多地显示用户界面，以便人们了解您的应用的功能。
• 在浏览器中截取应用的屏幕截图时，仅包含显示窗口中的内容。避免包含地址栏、标题栏或工具栏图标，因为这些图标在较小的屏幕尺寸上缩放效果不佳。
• GitHub 会在应用的登录页面上的一个框中显示您上传的屏幕截图，因此您无需在屏幕截图周围添加框或边框。
• 标题在简短明了时最有效。