Написание описания для вашего приложения

Ниже приведены рекомендации по полям, которые необходимо заполнить в разделе Описание черновика вашего описания.

Именование и ссылки

Название описания

Название вашего описания появится на главной странице GitHub Marketplace. Имя ограничено 255 символами и может отличаться от имени вашего приложения. Ваше описание не может иметь то же имя, что и существующая учетная запись в GitHub, если имя не является собственным именем пользователя или организации.

Очень короткое описание перечисления

Сообщество увидит "очень краткое" описание под названием вашего приложения на главной странице GitHub Marketplace.

Длина "Очень короткое описание"

Мы рекомендуем краткие описания длиной до 40–80 символов. Хотя вам разрешено использовать больше символов, клиентам легче быстро читать и понимать краткие описания.

Содержимое "Очень короткое описание"

• Опишите функциональность приложения. Не используйте это пространство для призыва к действию. Например:

  DO: упрощенное управление проектами для проблем с данными GitHub

  НЕ: управление проектами и проблемами на GitHub

  Совет. Добавьте "s" в конец команды в вызове действия, чтобы превратить его в приемлемое описание: управляет проектами и проблемами на GitHub

• Не повторяйте название приложения в описании.

  ПРАВИЛЬНО. Встроенный в контейнер инструмент непрерывной интеграции

  НЕПРАВИЛЬНО. Skycap – это встроенный в контейнер инструмент непрерывной интеграции

Форматирование "Очень короткое описание"

• Всегда используйте заглавные буквы в предложениях. Делайте заглавными только первую букву и имена собственные.

• Не используйте знаки препинания в конце краткого описания. Краткие описания не должны включать полных предложений и определенно не должны содержать более одного предложения.

• Делайте заглавными только имена собственные. Например:

  ПРАВИЛЬНО. Автоматизация доставки одним щелчком для веб-разработчиков

  НЕПРАВИЛЬНО. Автоматизация доставки одним щелчком для Веб-Разработчиков

• Всегда используйте запятую в списках.

• Избегайте ссылки на сообщество GitHub как "пользователи".

  ПРАВИЛЬНО. Автоматическое создание задач для сотрудников вашей организации

  НЕПРАВИЛЬНО. Автоматическое создание задач для пользователей организации

• Используйте аббревиатуры, только если они широко используются (например, API). Например:

  DO: Гибкие доски задач, оценки и отчеты без выхода GitHub

  НЕ: гибкие доски задач, оценки и отчеты, не оставляя GitHubпользовательского интерфейса

Категории

Приложения в GitHub Marketplace можно отображать по категориям. Выберите категорию, которая лучше всего описывает основные функции вашего приложения, в раскрывающемся списке Основная категория и при необходимости выберите Дополнительную категорию, подходящую вашему приложению.

Поддерживаемые языки

Если ваше приложение работает только с определенными языками, выберите до 10 языков программирования, которые поддерживает ваше приложение. Эти языки отображаются на странице с описанием GitHub Marketplace вашего приложения. Это поле необязательно.

URL-адреса описания

Обязательные URL-адреса

• URL-адрес службы поддержки клиентов. URL-адрес веб-страницы, на которую будут переходить ваши клиенты, когда у них возникнут вопросы о технической поддержке, продуктах или учетных записях.
• URL-адрес политики конфиденциальности. Веб-страница, на которой отображается политика конфиденциальности вашего приложения.
• URL-адрес установки: это поле отображается только для OAuth apps. (GitHub Apps не используйте этот URL-адрес, так как они используют необязательный URL-адрес установки на странице параметров GitHub App.) Когда клиент приобретает данные OAuth app, GitHub перенаправит клиентов на URL-адрес установки после установки приложения. Вам нужно будет перенаправить клиентов по адресу https://github.com/login/oauth/authorize, чтобы начать процесс авторизации OAuth. Дополнительные сведения см. в разделе "Обработка новых покупок и бесплатных пробных версий". Пропустите это поле, если вы перечисляете GitHub App.

Необязательные URL-адреса

• URL-адрес компании. Ссылка на веб-сайт вашей компании.
• URL-адрес состояния. Ссылка на веб-страницу, на которой отображаются сведения о состоянии вашего приложения. На страницах со сведениями о состоянии может содержатся информация о текущих и прошлых отчетах об инцидентах, состоянии времени работы веб-приложений и запланированном обслуживании.
• URL-адрес документации. Ссылка на документацию, которая обучает клиентов, как использовать ваше приложение.

Логотип и карточка функции

GitHub Marketplace отображает все описания с квадратным изображением логотипа внутри круглой метки, чтобы визуально различать приложения.

Карточка функции состоит из логотипа вашего приложения, названия и пользовательского фонового изображения, которое отражает индивидуальность вашего бренда. GitHub Marketplace отображает эту карточку, если ваше приложение является одним из четырех случайно выбранных приложений в верхней части главной страницы. Под карточкой функции каждого приложения отображается очень краткое описание.

По мере передачи изображений и выбора цветов в вашем черновом описании GitHub Marketplace будет отображаться предварительная версия вашего логотипа и карточки функции.

Рекомендации по логотипам

Необходимо передать пользовательское изображение для логотипа. Выберите цвет фона для значка.

• Передайте изображение логотипа размером не менее 200 x 200 пикселей, чтобы логотип не нужно было масштабировать при публикации описания.
• Логотипы будут обрезаны до квадрата. Рекомендуем передать квадратный файл изображения с вашим логотипом в центре.
• Для достижения наилучших результатов передайте изображение логотипа с прозрачным фоном.
• Чтобы значок идеально вписался, выберите для него цвет фона, который соответствует цвету фона (или прозрачности) изображения вашего логотипа.
• Старайтесь не использовать логотипы со словами или текстом. Логотипы с текстом плохо масштабируются на маленьких экранах.

Рекомендации по карточкам функций

Необходимо передать пользовательское фоновое изображение для карточки функции. Для названия приложения выберите цвет текста.

• Используйте шаблон или текстуру на фоновом изображении, чтобы придать вашей карточке визуальную идентичнность и чтобы она выделялась на темном фоне главной страницы GitHub Marketplace. Карточки функций должны отражать индивидуальность бренда вашего приложения.
• Фоновое изображение имеет размеры 965 x 482 пикселей (ширина x высота).
• Выберите цвет текста для названия вашего приложения, который четко выделяется на фоновом изображении.

Listing Details (Сведения списка)

Чтобы перейти на целевую страницу приложения, щелкните имя своего приложения на главной странице GitHub Marketplace или на странице категории. На целевой странице отображается более подробное описание приложения, состоящее из двух частей: "Вводное описание" и "Подробное описание."

Ваше "Вводное описание" отображается в верхней части целевой страницы GitHub Marketplace вашего приложения.

При нажатии Подробнее... отобразится "Подробное описание."

Следуйте этим рекомендациям для написания этих описаний.

Длина "Вводное описание" и "Подробное описание"

При публикации описания вашего приложения мы рекомендуем написать краткое изложение из 1–2 предложений длиной от 150 до 250 символов в обязательном поле "Вводное описание." Хотя разрешено использовать больше символов, клиентам легче быстро читать и понимать краткие сводки.

Вы можете добавить дополнительные сведения в необязательное поле "Подробное описание." Вы увидите это описание, щелкнув Подробнее... под вводным описанием на целевой странице вашего приложения. Подробное описание состоит из 3–5 ценностных предложений, каждое из которых описывается 1–2 предложениями. Для этого описания можно использовать до 1000 символов.

Содержимое "Вводное описание" и "Подробное описание"

• Всегда начинайте вводные описания с названия вашего приложения.

• Всегда пишите описания и ценностные предложения, используя живую речь.

Форматирование "Вводное описание" и "Подробное описание"

• Всегда используйте заглавные буквы в заголовках вашего ценностного предложения. Делайте заглавными только первую букву и имена собственные.

• Используйте точки в описаниях. Избегайте восклицательных знаков.

• Не используйте знаки препинания в конце заголовков вашего ценностного предложения. Заголовки ценностных предложений не должны содержать полные предложения и не должны включать больше одного предложения.

• Для каждого ценностного предложения укажите заголовок, за которым следует абзац описания. Отформатируйте заголовок как заголовок третьего уровня, используя Markdown. Например:

Освойте необходимые вам навыки

GitHub Skills поможет вам узнать, как использовать GitHub, эффективнее взаимодействовать с Markdown, обрабатывать конфликт слияния и многое другое.

• Делайте заглавными только имена собственные.

• Всегда используйте запятую в списках.

• Избегайте ссылки на сообщество GitHub как "пользователи".

  ПРАВИЛЬНО. Автоматическое создание задач для сотрудников вашей организации

  НЕПРАВИЛЬНО. Автоматическое создание задач для пользователей организации

• Используйте аббревиатуры, только если они широко используются (например, API).

Снимок экрана продукта

Вы можете передать до пяти скриншотов своего приложения для отображения на целевой странице вашего приложения. Добавьте необязательный заголовок к каждому снимку экрана, чтобы предоставить контекст. После передачи снимков экрана вы можете перетащить их в том порядке, в котором они должны отображаться на целевой странице.

Рекомендации по снимкам экрана

• Изображения должны быть высокого разрешения (не менее 1200 пикселей по ширине).
• Все изображения должны иметь одинаковую высоту и ширину (пропорции) во избежание скачков страницы, когда люди меняют одно изображение на другое.
• Покажите как можно больше пользовательского интерфейса, чтобы люди могли видеть, на что способно ваше приложение.
• Делая снимки экрана приложения в браузере, включайте только содержимое в окне отображения. Старайтесь не включать адресную строку, заголовок окна или значки панели инструментов, которые плохо масштабируются на экранах меньшего размера.
• GitHub отображает снимки экрана, которые вы отправляете в поле на целевой странице приложения, поэтому вам не нужно добавлять поля или границы на снимках экрана.
• Заголовки наиболее эффективны, когда они короткие и емкие.