Skip to content

Commit ecc9535

Browse files
Janu17Janu17
authored
Enhance managing your profile README documentation
Added detailed instructions and tips for managing a profile README, including prerequisites, formatting options, and examples.
1 parent 952acb7 commit ecc9535

1 file changed

Lines changed: 157 additions & 0 deletions

File tree

‎content/account-and-profile/how-tos/profile-customization/managing-your-profile-readme.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,161 @@
1+
----
2+
title: Managing your profile README
3+
intro: You can add a README to your {% data variables.product.prodname_dotcom %} profile to tell other people about yourself.
4+
versions:
5+
fpt: '*'
6+
ghes: '*'
7+
ghec: '*'
8+
permissions: Profile READMEs are not available to {% data variables.enterprise.prodname_managed_users %}.
9+
redirect_from:
10+
- /github/setting-up-and-managing-your-github-profile/managing-your-profile-readme
11+
- /github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme
12+
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme
13+
- /account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme
14+
shortTitle: Your profile README
15+
contentType: how-tos
16+
category:
17+
- Customize your profile
118
---
19+
20+
## Prerequisites
21+
22+
{% data variables.product.prodname_dotcom %} will display your profile README on your profile page if all of the following are true.
23+
24+
* You've created a repository with a name that matches your {% data variables.product.prodname_dotcom %} username.
25+
* The repository is public.
26+
* The repository contains a file named README.md in its root.
27+
* The README.md file contains any content.
28+
29+
> [!NOTE]
30+
> If you created a public repository with the same name as your username before July 2020, {% data variables.product.prodname_dotcom %} won't automatically show the repository's README on your profile. You can manually trigger a synchronization by editing the README file or choosing to rebuild your profile README in GitHub's account settings.
31+
32+
## Adding a profile README
33+
34+
{% data reusables.profile.create-profile-readme %}
35+
1. Above the right sidebar, click **Edit README**.
36+
37+
The generated README file is pre-populated with a template to give you some inspiration for your profile README.
38+
39+
## Formatting your profile README
40+
41+
Your profile README supports {% data variables.product.company_short %} Flavored Markdown, which means you can use rich formatting options to make your profile stand out.
42+
43+
### Suggested content for your profile README
44+
45+
Here are some ideas for content you might include in your profile README:
46+
47+
* **An introduction or "About me" section**: Write a brief introduction describing your background, interests, and professional goals
48+
* **Skills and expertise**: List your technical skills, programming languages, frameworks, and tools you're proficient with
49+
* **Professional experience**: Share highlights from your career, projects you're proud of, or roles you've held
50+
* **Current focus**: Mention what you're currently learning, building, or working on
51+
* **Contributions you're proud of**: Describe projects or contributions that showcase your best work
52+
* **Guidance for collaboration**: Let people know how they can contribute to your projects or work with you
53+
* **Hobbies and interests**: Share non-technical interests to help people get to know you better
54+
* **Contact or social links**: Include ways for people to reach out or follow your work
55+
56+
### Formatting tips
57+
58+
* **Use headings and sections** to organize your content and make it easy to scan
59+
* **Add emphasis** with bold (`**text**`) and italic (`*text*`) formatting
60+
* **Create lists** to highlight key points and skills
61+
* **Link to your pinned repositories** to showcase your best work
62+
* **Use badges** to display your tech stack, achievements, or certifications
63+
* **Add images and GIFs** to make your profile more visually interesting and engaging
64+
* **Use tables** to organize information like languages, tools, or experience
65+
66+
For detailed formatting guidance, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github).
67+
68+
### Using emojis
69+
70+
You can enhance your profile README with emojis to add personality and visual interest. For a summary of all the available emojis and their codes, see [Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/).
71+
72+
Common uses for emojis in profile READMEs include:
73+
* 🎯 Highlighting goals or focus areas
74+
* 💻 Marking technical skills or tools
75+
* 🌱 Indicating learning or growth
76+
* 📚 Referencing resources or learning materials
77+
* 🤝 Showing collaboration interests
78+
* ⚡ Emphasizing highlights or important points
79+
80+
## Editing your profile README
81+
82+
You can edit your profile README at any time:
83+
84+
1. Navigate to your GitHub profile
85+
2. In the profile README section, click the edit icon (pencil) next to your README
86+
3. Make your changes in the editor
87+
4. Click **Save** to publish your updates
88+
89+
Changes to your profile README appear immediately on your profile page.
90+
91+
## Removing a profile README
92+
93+
The profile README will be removed from your {% data variables.product.prodname_dotcom %} profile if any of the following apply:
94+
95+
* The README file is removed or made empty
96+
* The repository is made private
97+
* The repository name no longer matches your username due to a change in either or both names
98+
99+
### Recommended removal methods
100+
101+
If you want to stop displaying your profile README, we recommend one of these approaches depending on your needs:
102+
103+
**Option 1: Make the repository private** (recommended if you want to keep the README for personal use)
104+
1. Navigate to your username-named repository
105+
2. Go to **Settings**
106+
3. Under "Danger zone," find "Change repository visibility"
107+
4. Select **Make private**
108+
5. Confirm the change
109+
110+
For detailed steps, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility#changing-a-repositorys-visibility).
111+
112+
**Option 2: Delete the README file** (if you want to remove the content but keep the repository public)
113+
1. Navigate to your username-named repository
114+
2. Click the `README.md` file
115+
3. Click the delete button (trash icon)
116+
4. Commit the deletion
117+
118+
**Option 3: Clear the README content** (if you want to replace it with something else later)
119+
1. Edit the `README.md` file
120+
2. Delete all content
121+
3. Commit the change
122+
123+
## Updating your profile README
124+
125+
To keep your profile fresh and accurate, consider updating your README:
126+
127+
* When you learn new skills or technologies
128+
* After completing significant projects
129+
* When your focus or goals change
130+
* To refresh formatting, images, or styling
131+
* To highlight new achievements or contributions
132+
133+
## Tips for an effective profile README
134+
135+
* **Keep it concise**: Visitors often skim profiles, so prioritize key information
136+
* **Highlight your best work**: Link to your most impressive or relevant projects
137+
* **Show your personality**: Your README is a chance to stand out—make it uniquely you
138+
* **Keep it up to date**: An outdated README may give a negative impression
139+
* **Use white space**: Don't overcrowd your README—use spacing to improve readability
140+
* **Test formatting**: Preview your changes before saving to ensure everything looks good
141+
* **Avoid clutter**: Too many emojis, images, or styling can distract from your message
142+
143+
## Examples of profile READMEs
144+
145+
For inspiration, check out these well-designed profile READMEs:
146+
147+
* **GitHub's own examples**: Visit profiles of popular open-source contributors
148+
* **Showcase repositories**: Search GitHub for "awesome profile README" for curated collections
149+
* **Community templates**: Many developers share profile README templates for you to customize
150+
151+
## Next steps
152+
153+
* **Learn profile formatting**: For detailed formatting options, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
154+
* **Pin your best projects**: Showcase your work by pinning repositories to your profile. See [AUTOTITLE](/account-and-profile/how-tos/profile-customization/pinning-items-to-your-profile)
155+
* **Personalize your profile**: Add a bio, profile picture, and status. See [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile)
156+
* **Enhance your resume**: Use your profile to demonstrate skills to potential employers. See [AUTOTITLE](/account-and-profile/tutorials/using-your-github-profile-to-enhance-your-resume)
157+
* **Reference information**: For more profile settings and options, see [AUTOTITLE](/account-and-profile/reference/profile-reference)
158+
-
2159
title: Managing your profile README
3160
intro: You can add a README to your {% data variables.product.prodname_dotcom %} profile to tell other people about yourself.
4161
versions:

0 commit comments

Comments
 (0)