Skip to main content
All products
Apps

Creating a custom badge for your GitHub App

You can replace the default badge on your GitHub App by uploading your own logo image and customizing the background.

By default, a new GitHub App will have an automatically generated identicon. An identicon badge looks something like this:

An identicon, which consists of white pixels in a random pattern on a circular yellow background.

After you register 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. See "Writing a listing description for your app" for more guidance on customizing badges.

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.

To create a custom badge:

  1. In the upper-right corner of any page, click your profile photo, then click Settings.

    Screenshot of GitHub's account menu showing options for users to view and edit their profile, content, and settings. The menu item "Settings" is outlined in dark orange.

  2. In the left sidebar, click Developer settings.

  3. In the left sidebar, click GitHub Apps. Screenshot of the "Developer Settings" page in GitHub. An option labelled "GitHub Apps" is outlined in dark orange.

  4. To the right of the GitHub App you want to modify, click Edit.

  5. Under "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.

    Note: The "Badge background color" input field will only appear after you upload an application logo.

Next steps

For more information about listing your GitHub App in GitHub Marketplace, see "Listing an app on GitHub Marketplace".