1
0
mirror of synced 2025-12-19 18:10:59 -05:00

GitHub Discussions: labels and announcements (#19154)

This commit is contained in:
Laura Coursen
2021-05-18 13:54:18 -05:00
committed by GitHub
parent fbe0d47e53
commit 70e9bfefdf
14 changed files with 38 additions and 22 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

View File

@@ -23,14 +23,20 @@ If a repository administrator or project maintainer enables discussions for a re
For more information about management of discussions for your repository, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)."
### About categories and formats for discussions
### About discussion organization
You can organize discussions with categories and labels.
{% data reusables.discussions.you-can-categorize-discussions %} {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.repository-category-limit %}
For discussions with a question/answer format, an individual comment within the discussion can be marked as the discussion's answer. {% data reusables.discussions.github-recognizes-members %}
{% data reusables.discussions.about-announcement-format %}
For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."
{% data reusables.discussions.you-can-label-discussions %}
### Best practices for discussions
As a community member or maintainer, start a discussion to ask a question or discuss information that affects the community. For more information, see "[Collaborating with maintainers using discussions](/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions)."

View File

@@ -13,7 +13,9 @@ versions:
{% data reusables.discussions.about-discussions %} If you use or contribute to a project, you can start a discussion to make suggestions and engage with maintainers and community members about your plans, questions, ideas, and feedback. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
{% data reusables.discussions.about-categories-and-formats %} Repository administrators and project maintainers can delete a discussion. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)."
{% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.about-announcement-format %}
Repository administrators and project maintainers can delete a discussion. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)."
{% data reusables.discussions.github-recognizes-members %} These members appear in a list of the most helpful contributors to the project's discussions. As your project grows, you can grant higher access permissions to active members of your community. For more information, see "[Granting higher permissions to top contributors](/discussions/guides/granting-higher-permissions-to-top-contributors)"

View File

@@ -12,14 +12,17 @@ versions:
{% data reusables.discussions.about-discussions %} {% data reusables.discussions.about-categories-and-formats %}
{% data reusables.discussions.about-announcement-format %}
Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations. {% data reusables.discussions.repository-category-limit %} For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)."
### Default categories
| Category | Purpose | Type |
| Category | Purpose | Format |
| :- | :- | :- |
| 📣 Announcements | Updates and news from project maintainers | Announcement |
| #⃣ General | Anything and everything relevant to the project | Open-ended discussion |
|💡Ideas | Ideas to change or improve the project | Open-ended discussion |
|💡 Ideas | Ideas to change or improve the project | Open-ended discussion |
| 🙏 Q&A | Questions for the community to answer, with a question/answer format | Question and Answer |
| 🙌 Show and tell | Creations, experiments, or tests relevant to the project | Open-ended discussion |

View File

@@ -18,6 +18,8 @@ As a discussions maintainer, you can create community resources to encourage dis
For more information on facilitating a healthy discussion, see "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)."
{% data reusables.discussions.you-can-label-discussions %}
### Prerequisites
To manage discussions in a repository, discussions must be enabled for the repository. For more information, see "[Enabling or disabling discussions for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)."
@@ -31,8 +33,10 @@ You can also move a discussion to a different category.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.discussions.discussions-tab %}
{% data reusables.discussions.click-discussion-in-list %}
1. In the right sidebar, click {% octicon "pencil" aria-label="The pencil icon" %} **Edit pinned discussion**.
!["Pin discussion" in right sidebar for discussion](/assets/images/help/discussions/click-edit-pinned-discussion.png)
1. In the right sidebar, to the right of "Category", click {% octicon "gear" aria-label="The gear icon" %}.
!["Category" with gear icon](/assets/images/help/discussions/category-in-sidebar.png)
1. Click a category.
!["Change category" drop-down menu](/assets/images/help/discussions/change-category-drop-down.png)
### Pinning a discussion

View File

@@ -47,10 +47,12 @@ Anyone with access to a repository can create a discussion.
{% data reusables.discussions.starting-a-discussion %}
### Organizing discussions into relevant categories
### Organizing discussions
Repository owners and people with write access can create new categories to keep discussions organized. Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."
{% data reusables.discussions.you-can-label-discussions %}
### Promoting healthy conversations
People with write permissions for a repository can help surface important conversations by pinning discussions, deleting discussions that are no longer useful or are damaging to the community, and transferring discussions to more relevant repositories owned by the organization. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)."

View File

@@ -1,6 +1,6 @@
---
title: Managing labels
intro: 'You can classify issues and pull requests by creating, editing, applying, and deleting labels.'
intro: 'You can classify {% if currentVersion == "free-pro-team@latest" %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %} by creating, editing, applying, and deleting labels.'
redirect_from:
- /articles/managing-Labels
- /articles/labeling-issues-and-pull-requests
@@ -27,7 +27,7 @@ topics:
### About labels
You can manage your work on {% data variables.product.product_name %} by creating labels to categorize issues and pull requests. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any issue or pull request within that repository.
You can manage your work on {% data variables.product.product_name %} by creating labels to categorize {% if currentVersion == "free-pro-team@latest" %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% if currentVersion == "free-pro-team@latest" %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository.
Anyone with read access to a repository can view and search the repositorys labels. Anyone with triage access to a repository can apply/dismiss existing labels. To create, edit, apply, or delete a label, you must have write access to the repository.
@@ -39,13 +39,13 @@ Label | Description
--- | ---
`bug` | Indicates an unexpected problem or unintended behavior{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.17" %}
`documentation` | Indicates a need for improvements or additions to documentation{% endif %}
`duplicate` | Indicates similar issues or pull requests
`duplicate` | Indicates similar {% if currentVersion == "free-pro-team@latest" %}issues, pull requests, or discussions{% else %}issues or pull requests{% endif %}
`enhancement` | Indicates new feature requests
`good first issue` | Indicates a good issue for first-time contributors
`help wanted` | Indicates that a maintainer wants help on an issue or pull request
`invalid` | Indicates that an issue or pull request is no longer relevant
`question` | Indicates that an issue or pull request needs more information
`wontfix` | Indicates that work won't continue on an issue or pull request
`invalid` | Indicates that an {% if currentVersion == "free-pro-team@latest" %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} is no longer relevant
`question` | Indicates that an {% if currentVersion == "free-pro-team@latest" %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} needs more information
`wontfix` | Indicates that work won't continue on an {% if currentVersion == "free-pro-team@latest" %}issue, pull request, or discussion{% else %}issue or pull request{% endif %}
Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later.
@@ -57,7 +57,6 @@ Organization owners can customize the default labels for repositories in their o
### Creating a label
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-issue-pr %}
{% data reusables.project-management.labels %}
@@ -67,14 +66,11 @@ Organization owners can customize the default labels for repositories in their o
{% data reusables.project-management.label-color-randomizer %}
{% data reusables.project-management.create-label %}
### Applying labels to issues and pull requests
### Applying a label
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-issue-pr %}
{% data reusables.repositories.select-items-in-issue-or-pr-list %}
4. In the upper-right corner, click **Label**, then start typing the name of an existing label. Click the label's name to associate it with the selected items.
![Issues Milestone assignment drop-down](/assets/images/help/issues/issues_applying_labels_dropdown.png)
1. Navigate to the {% if currentVersion == "free-pro-team@latest" %}issue, pull request, or discussion{% else %}issue or pull request{% endif %}.
1. In the right sidebar, to the right of "Labels", click {% octicon "gear" aria-label="The gear icon" %}, then click a label.
!["Labels" drop-down menu](/assets/images/help/issues/labels-drop-down.png)
### Editing a label
@@ -88,6 +84,7 @@ Organization owners can customize the default labels for repositories in their o
{% data reusables.project-management.save-label %}
### Deleting a label
Deleting a label will remove the label from issues and pull requests.
{% data reusables.repositories.navigate-to-repo %}

View File

@@ -0,0 +1 @@
Maintainers can use categories with the announcement format to share information, releases, or events. To keep discussions in these categories focused on important updates, only people with maintain or admin permissions can create new discussions, but anyone can comment and reply.

View File

@@ -1 +1 @@
All discussions must be created in a category, and repository administrators and maintainers define the categories for a repository. Categories can contain open-ended conversations, or conversations with a question/answer format.
All discussions must be created in a category. People with maintain or admin permissions define the categories for a repository. Each category has a format: open-ended discussion, question and answer, or announcement.

View File

@@ -0,0 +1 @@
To organize discussions more granularly, you can apply labels. For example, you can use labels to indicate the status of a discussion to make triaging more efficient. Each repository has one shared set of labels for issues, pull requests, and discussions. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels)."