Skip to content
Tutorials Center
My learning

Topics

Lesson 18 of 36 ยท Issues, Projects and Discussions

Discussions, Wikis and Community Features

Know where each conversation belongs: GitHub Discussions for questions and ideas, issues for work, wikis for docs, plus stars, watching, sponsors and community moderation tools.

Not every conversation is a task. "How do I configure this?", "What should we build next?" and "Look what I made with your library" are all valuable, but they do not belong in an issue tracker, where every open item implies work. GitHub provides separate places for them. This lesson sorts out where each kind of talk belongs, and the social features that make a project feel alive.

Discussions

Discussions is a forum attached to a repository (or organization). Enable it in Settings > General > Features > Discussions. It has its own tab, and contributions are organized into categories. The defaults are:

Category Format Purpose
Announcements Announcement (only maintainers start threads) News and releases
General Open-ended Chat about the project
Ideas Open-ended Feature proposals before they become issues
Polls Poll Ask the community to vote
Q&A Question and answer Help requests with an accepted answer
Show and tell Open-ended Share what you built

In a Q&A category, anyone can mark one reply as the answer, which then appears at the top of the thread. This makes the forum searchable and saves repeating answers. Discussions support threaded replies, upvotes, reactions, pinning (up to four), locking, and labels. You can define your own categories and change a category's format (not all conversions are possible).

Discussion or issue?

A simple rule: an issue is something that can be closed.

  • A reproducible bug, a decided feature, a task: issue.
  • A question, a brainstorm, a poll, a support request: discussion.
  • Maintainers can convert an issue into a discussion and, from a discussion, create an issue to turn an agreed idea into work. Linking them keeps history together.

Many projects use the issue template chooser (see Labels, Milestones and Templates) to send questions to Discussions through a contact link.

JS Stand-in: route a message to the right place

Press Run (or Ctrl + Enter) to see the console output here.

No output.

Wikis

Every repository can have a wiki: a set of Markdown (or AsciiDoc and others) pages for longer documentation, with a sidebar and footer you can edit. Enable it under Settings > General > Features > Wikis. Under the hood, a wiki is its own Git repository at https://github.com/<owner>/<repo>.wiki.git, which means you can clone it, edit pages offline, and push:

Terminal
git clone https://github.com/octo-org/hello-world.wiki.git

Pages are links in double brackets: [[Installation]] links to the page named Installation. _Sidebar.md and _Footer.md appear on every page.

A wiki is separate from the code: it does not follow branches, it does not go through pull requests (anyone with write access, or everyone if you open it up, can edit), and it is not part of a fork. Consider that when choosing:

Need Use
Docs versioned with the code and reviewed in PRs A docs/ folder in the repository
A polished documentation site GitHub Pages (see the Pages lesson)
Quick, informal, loosely controlled notes The wiki
JS Stand-in: wiki link syntax

Press Run (or Ctrl + Enter) to see the console output here.

No output.

Stars, watching and following

  • Star a repository to bookmark it and show appreciation. Stars appear on your profile (Stars tab, organizable into lists) and are a rough popularity signal. They do not notify you.
  • Watch controls notifications: Participating and @mentions (default), All Activity, Ignore, or Custom (for example only releases, issues or discussions).
  • Follow a person to see their public activity in your feed.
  • Fork, as covered earlier, copies the repository to your account.

Sponsors and funding

GitHub Sponsors lets people fund maintainers monthly or once. Add a .github/FUNDING.yml file to show a Sponsor button on a repository:

YAML
github: [ada]
open_collective: hello-world
custom: ["https://example.com/donate"]

Moderating a community

Healthy communities need ground rules. GitHub gives maintainers:

  • A code of conduct file, shown from the community profile.
  • Hide or delete comments, with a reason (spam, off-topic, abuse, resolved).
  • Lock conversation to stop further comments (reason: off-topic, too heated, resolved, spam).
  • Block a user, or restrict interactions for a time (Settings > Moderation options) so only prior contributors can comment during a flare-up.
  • Saved replies for common answers such as "please open this as a discussion".

Be consistent and kind, and write down the rules before you need them.

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. Which is best placed in Discussions rather than Issues?

    Questions are conversations that do not need to be closed as tasks. Vulnerabilities should be reported privately.
  2. 2. What is special about a Q&A discussion category?

    An accepted answer is highlighted for future readers.
  3. 3. How can you edit a repository's wiki offline?

    The wiki is a separate Git repository.
  4. 4. Which watch option avoids most notification noise on a repository you do not own?

    That default only notifies you for conversations you are part of.

Summary

  • Use Issues for actionable work and Discussions for questions, ideas, polls and announcements; convert between them as needed.
  • Q&A discussions let anyone mark an accepted answer.
  • A wiki is a separate Git repository: handy for informal docs, but docs-as-code in the repository is easier to review.
  • Stars, watching, following and Sponsors build community; moderation tools and a code of conduct protect it.

Next: GitHub Actions: Your First Workflow