| title | intro | redirect_from | versions | topics | shortTitle | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creating a custom badge for your GitHub App |
{% data reusables.shortdesc.creating_custom_badges_github_apps %} |
|
|
|
Custom badge |
Every {% data variables.product.prodname_github_app %} has a badge. A badge is a square image inside a circular background.
By default, a new GitHub App will use an automatically generated identicon as a badge. An identicon badge looks something like this:
After you register a GitHub App, you can customize your app's badge by uploading a logo and selecting a background color. Your logo should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend an image dimension of 200 pixels by 200 pixels.
{% ifversion fpt or ghec %}
For more information about badges for {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %}, see AUTOTITLE. 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 %}
{% data reusables.apps.settings-step %} {% data reusables.apps.enterprise-apps-steps %} {% data reusables.user-settings.modify_github_app %}
- Under "Display information", drag and drop an image from a local folder or click Upload a logo to select an image from your computer.
- Optionally, crop your image.
- Click Set new avatar.
- Under "Badge background color", type the hexadecimal color code of the background color for your badge.
{% ifversion fpt or ghec %}
Note
The "Badge background color" input field will only appear after you upload a logo.
{% endif %}
{% ifversion fpt or ghec %}
For more information about listing your {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, see AUTOTITLE.
{% endif %}