ab6d8b7654
Co-authored-by: Sarah Edwards <skedwards88@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
2.6 KiB
title, intro, redirect_from, versions, topics, shortTitle
| title | intro | redirect_from | versions | topics | shortTitle | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Creating a custom badge for your GitHub App | {% data reusables.shortdesc.creating_custom_badges_github_apps %} |
|
|
|
Custom badges |
By default, a new GitHub App will have an automatically generated identicon. An identicon badge looks something like this:
After you create a GitHub App, you can customize your app's badge by uploading a logo and selecting a background color. A badge is a square logo image inside of a circular badge. You can choose a background color for the badge, which can visually distinguish your app.
Your logo should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend an image size of at least 200px x 200px. {% ifversion fpt or ghec %}See "AUTOTITLE" for more guidance on customizing badges.{% endif %}
{% ifversion fpt or ghec %}
You can change a custom badge for a GitHub App that already has an approved Marketplace listing by navigating to https://github.com/marketplace/manage.
{% endif %}
To create a custom badge:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
{% data reusables.user-settings.modify_github_app %}
5. In "Display information", drag-and-drop an image from a local folder or click Upload a logo to select an image from your computer.
6. Optionally, crop your image. When you're done, click Set new avatar.
7. Under "Badge background color", type the hexadecimal color code of the background color for your badge.
{% ifversion fpt or ghec %} {% note %}
Note: The "Badge background color" input field will only appear after you upload an application logo.
{% endnote %} {% endif %} {% ifversion fpt or ghec %}
Next steps
For more information about creating a Marketplace listing for this app, see "AUTOTITLE".
{% endif %}