Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

iTechGuides is reader-supported. When you buy through links on our site, we may earn an affiliate commission. As an Amazon Associate I earn from qualifying purchases. Learn more

You can give visitors a place to comment on your GitHub profile by linking to a GitHub Discussion from your profile README. The README appears on your profile; the Discussion hosts the conversation. GitHub’s documentation describes Discussions as a repository or organization feature, not as a comment thread embedded directly in an individual profile.

How the profile comment setup works

Think of this as two connected pieces: a profile README that welcomes visitors and points them to a conversation, and a Discussion where they can post. GitHub describes Discussions as a place for conversations that do not need to be tracked like issues and are not related to code. See GitHub’s overview of profile elements and its Discussions quickstart.

Create or check your profile README

Your profile README is shown when you have a public repository named exactly after your GitHub username, with a nonempty README.md at the repository root. GitHub says managed user accounts cannot use profile READMEs. Follow GitHub’s profile README instructions to create or edit the repository and file.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  1. Create a public repository whose name exactly matches your username, if you do not already have one.

  2. Add a nonempty README.md at the repository root, or edit the existing file.

  3. Write a short welcome and explain the purpose of the linked discussion. For example: “Questions or comments? Join the conversation in my GitHub Discussion.”

  4. Preview the README, then commit the changes. If you commit directly to main, the update is visible to profile visitors.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

To check Markdown comments in Preview, GitHub’s writing guide gives this syntax: <!-- COMMENT -->. The text inside the comment is hidden in the rendered output. See GitHub’s guide to writing on GitHub.

If the README stops appearing, check that the repository is public, its name still matches your username, and the root README is not empty. GitHub also notes that an older same-name public repository created before July 2020 may need to be added with “Share to profile.”

Choose where the conversation will live

Use repository Discussions for a project-centered conversation. Its visibility follows the repository’s visibility, and repository access rules govern who can participate. Use organization Discussions when you want the conversation associated with an organization instead; an organization owner enables the feature and selects a source repository. Existing discussions do not transfer if the organization’s source repository is changed.

Destination

Best suited to

Setup and access

Repository Discussions

Conversation about one project or repository community

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Enabled in repository settings; visibility follows the repository

Organization Discussions

A conversation associated with an organization

An organization owner enables it and chooses a source repository; changing that source does not move existing discussions

Enable Discussions and create a destination post

For a repository

  1. Open the repository and go to Settings.

  2. Under Features, select Set up discussions. Repository owners and people with write access can enable Discussions.

  3. Review or edit the welcome post during setup.

  4. Open the repository’s Discussions tab, choose a category, enter a clear title and body, and start the discussion.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Repository owners and people with write access can create discussion categories. Because the discussion inherits repository visibility, choose a repository whose audience and access settings fit the conversation you want.

For an organization

An organization owner enables Discussions in the organization settings and chooses a source repository. The discussions are available on the organization and source repository discussion pages. Check the source repository and its visibility before directing profile visitors there.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Link to the discussion from your profile

Copy the URL of the discussion you created and add it to the profile README as a Markdown link. Replace the example address with your actual discussion URL:

[Leave a comment or ask a question](https://github.com/OWNER/REPOSITORY/discussions/NUMBER)

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Use a label that tells visitors what belongs there—such as questions, introductions, or feedback—and make sure the destination is accessible to the people you are inviting. The README is the invitation and link; the Discussion is where replies appear.

Welcome visitors and manage the conversation

If you own the discussion space, set expectations in the welcome post or relevant category description. Explain what visitors can post and how you will handle off-topic or inappropriate content. GitHub Discussions supports welcome posts, pinning, and moderation tools; the available permissions depend on the repository or organization setup. See GitHub’s guide to managing discussions.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.