为您的应用编写列表描述

以下是您需要在草稿列表的“列表描述”部分填写的内容的指南。

命名和链接

列表名称

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

列表的极简描述

社区将在GitHub Marketplace 首页上您的应用名称下看到“极简”描述。

“极简描述”的长度

我们建议将简短描述保持在 40-80 个字符。虽然您可以使用更多字符，但简洁的描述更容易让客户快速阅读和理解。

“极简描述”的内容

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

  DO: GitHub 问题轻量级项目管理

  DON'T: 在 GitHub 上管理您的项目和问题

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

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

  DO: 一个容器原生持续集成工具

  DON'T: Skycap 是一个容器原生持续集成工具

“非常简短的描述”格式

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

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

• 仅将专有名词大写。例如

  DO: 为 Web 开发人员提供一键式交付自动化

  DON'T: 为 Web 开发人员提供一键式交付自动化

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

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

  DO: 为您组织中的人员自动创建问题

  DON'T: 为组织的用户自动创建问题

• 避免使用缩略语，除非它们是公认的（如 API）。例如

  DO: 不离开 GitHub 的敏捷任务板、估算和报告

  DON'T: 不离开 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 技能可以帮助你学习如何使用 GitHub，用 Markdown 更有效地进行沟通，处理合并冲突等等。

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

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

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

  DO: 为您组织中的人员自动创建问题

  DON'T: 为组织的用户自动创建问题

• 避免使用缩略词，除非它们是公认的（例如 API）。

产品截图

你可以上传最多五张应用程序截图到你的应用程序的登录页面。为每张截图添加可选的标题以提供上下文。上传截图后，你可以将它们拖放到你想要在登录页面上显示的顺序。

截图指南

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