Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 3.92 KB

classifying-your-repository-with-topics.md

File metadata and controls

54 lines (38 loc) · 3.92 KB
title intro redirect_from versions topics shortTitle
Classifying your repository with topics
To help other people find and contribute to your project, you can add topics to your repository related to your project's intended purpose, subject area, affinity groups, or other important qualities.
/articles/about-topics
/articles/classifying-your-repository-with-topics
/github/administering-a-repository/classifying-your-repository-with-topics
/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics
fpt ghes ghec
*
*
*
Repositories
Classify with topics

About topics

With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% ifversion fpt or ghec %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}.

Screenshot of the github/docs repository. In the sidebar, three topics are outlined in orange: "docs," "hacktoberfest," and "works-with-codespaces."

To browse the most used topics, go to {% data variables.product.product_url %}/topics/.

{% ifversion fpt or ghec %}You can contribute to {% data variables.product.github %}'s set of featured topics in the github/explore repository. {% endif %}

Repository admins can add any topics they'd like to a repository. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.{% ifversion fpt or ghec %} Additionally, {% data variables.product.github %} analyzes public repository content and generates suggested topics that repository admins can accept or reject. Private repository content is not analyzed and does not receive topic suggestions.{% endif %}

{% ifversion fpt %}Public and private{% elsif ghec or ghes %}Public, private, and internal{% endif %} repositories can have topics, although you will only see private repositories that you have access to in topic search results.

You can search for repositories that are associated with a particular topic. For more information, see AUTOTITLE. You can also search for a list of topics on {% data variables.product.github %}. For more information, see AUTOTITLE.

When creating a topic:

  • Use lowercase letters, numbers, and hyphens.
  • Use 50 characters or less.
  • Add no more than 20 topics.

Adding topics to your repository

Note

Topic names are always public, even if you create the topic from within a private repository.

{% data reusables.repositories.navigate-to-repo %}

  1. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}.

    Screenshot of the top right of the main page for a repository. The "Edit repository metadata" button, shown as a gear icon, is outlined in orange.

  2. Under "Topics", start to type the topic you want to add to your repository to display a dropdown menu of any matching topics. Click the topic you want to add or continue typing to create a new topic.

    Screenshot of the "Topics" field showing example topics: "docs" and "works-with-codespaces." A "Suggested" topic "documentation" is shown below.

  3. Optional, if there are "Suggested" topics displayed under the "Topics" field, click {% octicon "plus" aria-label="Add this topic" %} to add or {% octicon "dash" aria-label="Decline this topic" %} to decline the suggested topic.

  4. After you've finished adding topics, click Save changes.