Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 69 additions & 19 deletions content/account-and-profile/concepts/about-your-profile.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: About your profile
shortTitle: Personal profile
intro: 'Your profile page tells people your story through the information you share, the contributions you make, and the projects you showcase.'
intro: 'Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.'
redirect_from:
- /articles/viewing-your-feeds
- /articles/profile-pages
Expand All @@ -16,29 +16,79 @@ versions:
topics:
- Profiles
---
You can tell other people a little bit about yourself by writing a bio. With the help of [@mentions](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. The bio field is limited to 160 characters.

For a longer-form and more prominent way of displaying customized information about yourself, you can create a profile README. If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page.

If you have the activity overview section enabled for your profile and you @mention an organization you're a member of in your profile bio, then that organization will be featured first in your activity overview.
Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.

![Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.](/assets/images/help/repository/profile-with-readme.png)
{% data reusables.profile.profile-visibility %}

People who visit your profile can also see:
## Key profile elements

* A timeline of your contribution activity, like issues and pull requests you've opened, commits you've made, and pull requests you've reviewed
* Repositories and gists you own or contribute to. You can showcase your best work by pinning repositories and gists to your profile.
* Repositories you've starred{% ifversion fpt or ghec %} and organized into lists{% endif %}
* An overview of your activity in organizations, repositories, and teams you're most active in{% ifversion fpt or ghec %}
* Badges and Achievements that highlight your activity and show if you use {% data variables.product.prodname_pro %} or participate in programs like the {% data variables.product.prodname_arctic_vault %}, {% data variables.product.prodname_sponsors %}, or the {% data variables.product.company_short %} Developer Program{% endif %}
{%- ifversion profile-pronouns %}
* Your pronouns (if you have set them)
{%- endif %}
{%- ifversion fpt or ghec %}
* Mutual connections, including people both you and the viewer follow
{%- endif %}
* Your status message sharing information about your availability (if you have set one)
Your profile includes these customizable elements:

* **Profile README**: A customizable section at the top of your profile
* **Personal info**: Profile picture, name,{% ifversion profile-pronouns %} pronouns,{% endif %} and bio
* **Contribution activity**: Visualizes your work on {% data variables.product.github %}
* **Pinned items**: Repositories and gists you choose to highlight
* **Status**: Shows your current availability and what you're working on
* **Achievements and badges**: Recognizes your participation in programs or milestones

## Your profile README

You can share information about yourself with the community on {% data variables.product.prodname_dotcom %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.

You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.

* An "About me" section that describes your work and interests
* Contributions you're proud of, and context about those contributions
* Guidance for getting help in communities where you're involved

You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github).

{% ifversion fpt %}

## Private profiles

To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.github %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity.

After making your profile private, you can still view all your information when you visit your own profile.

For more information, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private).

### Differences between private and public profiles

When your profile is private, the following content is hidden from your profile page:

* Achievements and highlights
* Activity overview and activity feed
* Contribution graph
* Follower and following counts
* Follow and Sponsor buttons
* Organization memberships
* Stars, projects, packages, and sponsoring tabs
* Your pronouns

When your profile is private, the following optional fields are still **publicly** visible:

* README
* Bio
* Profile picture

When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations:

* Activity feeds for other users
* Discussions leaderboards
* Site-wide search results
* The [Trending](https://github.com/trending) page

## Profile visibility options

You can control the visibility of specific profile elements or set your entire profile to private.

{% endif %}

## Next steps

To start customizing your profile, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile) and [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
* For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile).
* For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile).
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).
29 changes: 2 additions & 27 deletions content/account-and-profile/get-started/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,10 @@ topics:
shortTitle: Profile
---

## About profiles
## About your {% data variables.product.github %} profile

Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.
Your profile is how other people discover and learn about you on {% data variables.product.github %}. You can customize your profile to highlight your best work and share more about yourself.

{% ifversion fpt or ghec %}

> [!IMPORTANT]
> Any details you add to your public profile will be visible to all {% data variables.product.github %} users, including in regions where local laws, regulations, or cultural norms may pose risks to expressing your identity. We respect everyone’s decision about whether or not to share information about themselves on their {% data variables.product.github %} profile.
{% endif %}

## Key profile elements

Your profile includes these customizable elements:

* **Personal info**: Profile picture, name, bio, and pronouns
* **Status**: Shows your current availability and what you're working on
* **Pinned items**: Repositories and gists you choose to highlight
* **Contribution activity**: Visualizes your work on {% data variables.product.github %}
* **Profile README**: A customizable section at the top of your profile
* **Achievements and badges**: Recognizes your participation in programs or milestones

## Profile visibility

You can control the visibility of specific profile elements or set your entire profile to private.

## Next steps

* For more details about your profile, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile).
* For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile).
* For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile).
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,6 @@ redirect_from:
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme
shortTitle: Your profile README
---
## About your profile README

You can share information about yourself with the community on {% data variables.product.prodname_dotcom %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.

You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.

* An "About me" section that describes your work and interests
* Contributions you're proud of, and context about those contributions
* Guidance for getting help in communities where you're involved

![Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.](/assets/images/help/repository/profile-with-readme.png)

You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github). For a hands-on guide to customizing your profile README, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github).

## Prerequisites

Expand Down Expand Up @@ -59,10 +46,6 @@ The profile README will be removed from your {% data variables.product.prodname_

The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility#changing-a-repositorys-visibility).

## Further reading
## Next steps

* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
* [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-member-only-organization-profile-readme)
{%- ifversion enterprise-readme %}
* [AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)
{%- endif %}
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,19 @@ topics:
- Profiles
shortTitle: Pin items
---
You can pin a public repository if you own the repository or you've made contributions to the repository within the last year. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)

You can pin any public gist you own.

Pinned items include important information about the item, like the number of stars a repository has received or the first few lines of a gist. Once you pin items to your profile, the "Pinned" section replaces the "Popular repositories" section on your profile.

You can reorder the items in the "Pinned" section. In the upper-right corner of a pin, click {% octicon "grabber" aria-label="The grabber symbol" %} and drag the pin to a new location.
## Pinning items to your profile

{% data reusables.profile.access_profile %}
1. At the top of the "Popular repositories" or "Pinned" section, click **Customize your pins**.

![Screenshot of the "Pinned" section of a user profile. A link, labeled "Customize your pins", is highlighted with an orange outline.](/assets/images/help/profile/customize-pinned-repositories.png)
1. Optionally, to change which items are included in the searchable list, next to "Show", select or deselect **Repositories** and **Gists**.
1. Optionally, to make it easier to find a specific item, in the "Filter repositories and gists" field, type the name of a user, organization, repository, or gist.
1. Optionally, reorder the items in the "Pinned" section. In the upper-right corner of a pin, click {% octicon "grabber" aria-label="The grabber symbol" %} and drag the pin to a new location.
1. Select up to six repositories and gists, combined.
1. Click **Save pins**.

## Further reading

* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#pinning-items-to-your-profile).
Original file line number Diff line number Diff line change
Expand Up @@ -9,47 +9,15 @@ shortTitle: Set profile to private
redirect_from:
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private
---
## About private profiles

To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.prodname_dotcom %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity.

After making your profile private, you can still view all your information when you visit your own profile.

Private profiles cannot receive sponsorships under [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). To be eligible for {% data variables.product.prodname_sponsors %}, your profile cannot be private.

## Differences between private and public profiles

When your profile is private, the following content is hidden from your profile page:

* Achievements and highlights
* Activity overview and activity feed
* Contribution graph
* Follower and following counts
* Follow and Sponsor buttons
* Organization memberships
* Stars, projects, packages, and sponsoring tabs
* Your pronouns

> [!NOTE]
> When your profile is private, some optional fields are still publicly visible, such as the README, biography, and profile picture.

## Changes to reporting on your activities

By making your profile private, you will not remove or hide past activity; this setting only applies to your activity while the private setting is enabled.

When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations:

* Activity feeds for other users
* Discussions leaderboards
* Site-wide search results
* The [Trending](https://github.com/trending) page

> [!NOTE]
> Your activity on public repositories will still be publicly visible to anyone viewing those repositories, and some activity data may still be available through the {% data variables.product.prodname_dotcom %} API.

## Changing your profile's privacy settings

{% data reusables.user-settings.access_settings %}
1. Navigate to the "Public profile" section, and scroll down to "Contributions & Activity"
1. Select the checkbox next to **Make profile private and hide activity**.
{% data reusables.user-settings.update-preferences %}

## Next steps

* For more information about private profiles, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile#private-profiles).
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#limitations-of-private-profiles).
Loading
Loading