Skip to content

Commit

Permalink
🔄 synced file(s) with conda/infrastructure
Browse files Browse the repository at this point in the history
  • Loading branch information
conda-bot committed Aug 2, 2024
1 parent d908fe1 commit fc7029a
Show file tree
Hide file tree
Showing 8 changed files with 369 additions and 105 deletions.
42 changes: 3 additions & 39 deletions .github/ISSUE_TEMPLATE/0_bug.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# edit this in https://github.com/conda/infrastructure

name: Bug Report
description: Create a bug report.
labels:
Expand All @@ -13,7 +15,7 @@ body:
Since there are already a lot of open issues, please also take a moment to search existing ones to see if your bug has already been reported. If you find something related, please upvote that issue and provide additional details as necessary.
💐 Thank you for helping to make Conda better. We would be unable to improve Conda without our community!
💐 Thank you for helping to make `conda/infrastructure` better. We would be unable to improve `conda/infrastructure` without our community!
- type: checkboxes
id: checks
attributes:
Expand All @@ -31,45 +33,7 @@ body:
description: What should have happened instead? Please provide as many details as possible. The more information provided, the more likely we are able to replicate your problem and offer a solution.
validations:
required: true
- type: textarea
id: info
attributes:
label: Conda Info
description: |
Let's collect some basic information about your conda install.
Please run the following command from your command line and paste the output below.
```bash
conda info
```
render: shell
- type: textarea
id: config
attributes:
label: Conda Config
description: |
Let's collect any customizations you may have for your conda install.
Please run the following command from your command line and paste the output below.
```bash
conda config --show-sources
```
render: shell
- type: textarea
id: list
attributes:
label: Conda list
description: |
The packages installed into your environment can offer clues as to the problem you are facing.
Please activate the environment within which you are encountering this bug, run the following command from your command line, and paste the output below.

```bash
conda list --show-channel-urls
```
render: shell
- type: textarea
id: context
attributes:
Expand Down
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/1_feature.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# edit this in https://github.com/conda/infrastructure

name: Feature Request
description: Create a feature request.
labels:
Expand All @@ -13,7 +15,7 @@ body:
Since there are already a lot of open issues, please also take a moment to search existing ones to see if your feature request has already been submitted. If you find something related, please upvote that issue and provide additional details as necessary.
💐 Thank you for helping to make Conda better. We would be unable to improve Conda without our community!
💐 Thank you for helping to make `conda/infrastructure` better. We would be unable to improve `conda/infrastructure` without our community!
- type: checkboxes
id: checks
attributes:
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/2_documentation.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# edit this in https://github.com/conda/infrastructure

name: Documentation
description: Create a documentation related issue.
labels:
Expand Down
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/epic.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# edit this in https://github.com/conda/infrastructure

name: Epic
description: A collection of related tickets.
labels:
Expand All @@ -15,7 +17,8 @@ body:
Since there are already a lot of open issues, please also take a moment to search existing ones to see if a similar epic has already been opened. If you find something related, please upvote that issue and provide additional details as necessary.
💐 Thank you for helping to make Conda better. We would be unable to improve Conda without our community!
💐 Thank you for helping to make `conda/infrastructure` better. We would be unable to improve `conda/infrastructure` without our community!
- type: checkboxes
id: checks
attributes:
Expand Down
289 changes: 286 additions & 3 deletions CODE_OF_CONDUCT.md

Large diffs are not rendered by default.

52 changes: 31 additions & 21 deletions HOW_WE_USE_GITHUB.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- edit this in https://github.com/conda/infrastructure -->

<!-- absolute URLs -->
[conda-org]: https://github.com/conda
[sub-team]: https://github.com/conda-incubator/governance#sub-teams
Expand All @@ -15,17 +17,18 @@

[infrastructure]: https://github.com/conda/infrastructure
[workflow-sync]: https://github.com/conda/infrastructure/blob/main/.github/workflows/sync.yml
[workflow-update]: https://github.com/conda/infrastructure/blob/main/.github/workflows/update.yml
[labels-global]: https://github.com/conda/infrastructure/blob/main/.github/global.yml

<!-- relative URLs -->
[workflow-cla]: /.github/workflows/cla.yml
[workflow-issues]: /.github/workflows/issues.yml
[workflow-labels]: /.github/workflows/labels.yml
[workflow-lock]: /.github/workflows/lock.yml
[workflow-project]: /.github/workflows/project.yml
[workflow-stale]: /.github/workflows/stale.yml
[labels-local]: /.github/labels.yml
[labels-page]: ../../labels
[workflow-cla]: https://github.com/conda/infrastructure/blob/main/.github/workflows/cla.yml
[workflow-issues]: https://github.com/conda/infrastructure/blob/main/.github/workflows/issues.yml
[workflow-labels]: https://github.com/conda/infrastructure/blob/main/.github/workflows/labels.yml
[workflow-lock]: https://github.com/conda/infrastructure/blob/main/.github/workflows/lock.yml
[workflow-project]: https://github.com/conda/infrastructure/blob/main/.github/workflows/project.yml
[workflow-stale]: https://github.com/conda/infrastructure/blob/main/.github/workflows/stale.yml
[labels-local]: https://github.com/conda/infrastructure/blob/main/.github/labels.yml
[labels-page]: https://github.com/conda/infrastructure/labels

# How We Use GitHub

Expand Down Expand Up @@ -105,7 +108,7 @@ Sorting engineers are a conda governance [sub-team][sub-team]; they are a group

New issues that are opened in any of the repositories in the [conda GitHub organization][conda-org] will show up in the "Sorting" tab of the [Planning project][project-planning]. There are two [GitHub Actions][docs-actions] workflows utilized for this purpose; [`.github/workflows/issues.yml`][workflow-issues] and [`.github/workflows/project.yml`][workflow-project].

The GitHub Actions in the [`conda/infrastructure`][infrastructure] repository are viewed as canonical; the [`.github/workflows/sync.yml` workflow][workflow-sync] sends out any modifications to other `conda` repositories from there.
The GitHub workflows in the [`conda/infrastructure`][infrastructure] repository are viewed as canonical; the [`.github/workflows/sync.yml` workflow][workflow-sync] pushes any modifications to other repositories from there and individual repositories can pull additional files using the [`.github/workflows/update.yml`][workflow-update] workflow.

### What is done about the issues in the "Sorting" tab?

Expand All @@ -126,8 +129,8 @@ For more information on the sorting process, see [Issue Sorting Procedures](#iss

Items move out of the ["Sorting" tab][project-sorting] once the investigatory phase described in [What is done about the issues in the "Sorting" tab?](#what-is-done-about-the-issues-in-the-sorting-tab) has concluded and the sorting engineer has enough information to make a decision about the appropriate resolution schedule for the issue. The additional tabs in the project board that the issues can be moved to include the following:

- **"Support"** - Any issue in the ["Support" tab of the Planning board][project-support] is a request for support and is not a feature request or a bug report. Add the [`type::support`](https://github.com/conda/infrastructure/labels/type%3A%3Asupport) label to move an issue to this tab.
- **"Backlog"** - The issue has revealed a bug or feature request. We have collected enough details to understand the problem/request and to reproduce it on our own. These issues have been moved into the [Backlog tab of the Planning board][project-backlog] at the end of the sorting rotation during Refinement. Add the [`backlog`](https://github.com/conda/infrastructure/labels/backlog) label to move an issue to this tab.
- **"Support"** - Any issue in the ["Support" tab of the Planning board][project-support] is a request for support and is not a feature request or a bug report. Add the https://github.com/conda/infrastructure/labels/type%3A%3Asupport label to move an issue to this tab.
- **"Backlog"** - The issue has revealed a bug or feature request. We have collected enough details to understand the problem/request and to reproduce it on our own. These issues have been moved into the [Backlog tab of the Planning board][project-backlog] at the end of the sorting rotation during Refinement. Add the https://github.com/conda/infrastructure/labels/backlog label to move an issue to this tab.
- **"Closed"** - The issue was closed due to being a duplicate, being redirected to a different project, was a user error, a question that has been resolved, etc.

### Where do work issues go after being sorted?
Expand All @@ -143,12 +146,12 @@ Issues are "backlogged" when they have been sorted but not yet earmarked for an
Global automation procedures synced out from the [`conda/infrastructure`][infrastructure] repo include:

- [Marking of issues and pull requests as stale][workflow-stale], resulting in:
- issues marked as [`type::support`](https://github.com/conda/infrastructure/labels/type%3A%3Asupport) being labeled stale after 21 days of inactivity and being closed after 7 further days of inactivity (that is, closed after 30 inactive days total)
- all other inactive issues (not labeled as [`type::support`](https://github.com/conda/infrastructure/labels/type%3A%3Asupport) being labeled stale after 365 days of inactivity and being closed after 30 further days of inactivity (that is, closed after an approximate total of 1 year and 1 month of inactivity)
- issues marked as https://github.com/conda/infrastructure/labels/type%3A%3Asupport being labeled stale after 21 days of inactivity and being closed after 7 further days of inactivity (that is, closed after 30 inactive days total)
- all other inactive issues (not labeled as https://github.com/conda/infrastructure/labels/type%3A%3Asupport being labeled stale after 365 days of inactivity and being closed after 30 further days of inactivity (that is, closed after an approximate total of 1 year and 1 month of inactivity)
- all inactive pull requests being labeled stale after 365 days of inactivity and being closed after 30 further days of inactivity (that is, closed after an approximate total of 1 year and 1 month of inactivity)
- [Locking of closed issues and pull requests with no further activity][workflow-lock] after 365 days
- [Adding new issues and pull requests to the respective project boards][workflow-project]
- [Indicating an issue is ready for the sorting engineer's attention][workflow-issues] by toggling [`pending::feedback`](https://github.com/conda/infrastructure/labels/pending%3A%3Afeedback) with [`pending::support`](https://github.com/conda/infrastructure/labels/pending%3A%3Asupport) after a contributor leaves a comment
- [Indicating an issue is ready for the sorting engineer's attention][workflow-issues] by toggling https://github.com/conda/infrastructure/labels/pending%3A%3Afeedback with https://github.com/conda/infrastructure/labels/pending%3A%3Asupport after a contributor leaves a comment
- [Verifying that contributors have signed the CLA][workflow-cla] before allowing pull requests to be merged; if the contributor hasn't signed the CLA previously, merging is be blocked until a manual review can be done
- [Syncing out templates, labels, workflows, and documentation][workflow-sync] from [`conda/infrastructure`][infrastructure] to the other repositories

Expand All @@ -166,9 +169,9 @@ Labeling is a very important means for sorting engineers to keep track of the cu

Each label has an associated description that clarifies how the label should be used. Hover on the label to see its description. Label colors are used to distinguish labels by category.

Generally speaking, labels with the same category are considered mutually exclusive, but in some cases labels sharing the same category can occur concurrently, as they indicate qualifiers as opposed to types. For example, we may have the following types, [`type::bug`](https://github.com/conda/infrastructure/labels/type%3A%3Abug), [`type::feature`](https://github.com/conda/infrastructure/labels/type%3A%3Afeature), and [`type::documentation`](https://github.com/conda/infrastructure/labels/type%3A%3Adocumentation), where for any one issue there would be _at most_ **one** of these to be defined (_i.e._ an issue should not be a bug _and_ a feature request at the same time). Alternatively, with issues involving specific operating systems (_i.e._, [`os::linux`](https://github.com/conda/infrastructure/labels/os%3A%3Alinux), [`os::macos`](https://github.com/conda/infrastructure/labels/os%3A%3Amacos), and [`os::windows`](https://github.com/conda/infrastructure/labels/os%3A%3Awindows)), an issue could be labeled with one or more, depending on the system(s) the issue occurs on.
Generally speaking, labels with the same category are considered mutually exclusive, but in some cases labels sharing the same category can occur concurrently, as they indicate qualifiers as opposed to types. For example, we may have the following types, https://github.com/conda/infrastructure/labels/type%3A%3Abug, https://github.com/conda/infrastructure/labels/type%3A%3Afeature, and https://github.com/conda/infrastructure/labels/type%3A%3Adocumentation, where for any one issue there would be _at most_ **one** of these to be defined (_i.e._ an issue should not be a bug _and_ a feature request at the same time). Alternatively, with issues involving specific operating systems (_i.e._, https://github.com/conda/infrastructure/labels/os%3A%3Alinux, https://github.com/conda/infrastructure/labels/os%3A%3Amacos, and https://github.com/conda/infrastructure/labels/os%3A%3Awindows), an issue could be labeled with one or more, depending on the system(s) the issue occurs on.

Please note that there are also automation policies in place that are affected by labeling. For example, if an issue is labeled as [`type::support`](https://github.com/conda/infrastructure/labels/type%3A%3Asupport), that issue will be marked [`stale`](https://github.com/conda/infrastructure/labels/stale) after 21 days of inactivity and auto-closed after seven more days without activity (30 inactive days total), which is earlier than issues without this label. See [What automation procedures are currently in place?](#what-automation-procedures-are-currently-in-place) for more details.
Please note that there are also automation policies in place that are affected by labeling. For example, if an issue is labeled as https://github.com/conda/infrastructure/labels/type%3A%3Asupport, that issue will be marked https://github.com/conda/infrastructure/labels/stale after 21 days of inactivity and auto-closed after seven more days without activity (30 inactive days total), which is earlier than issues without this label. See [What automation procedures are currently in place?](#what-automation-procedures-are-currently-in-place) for more details.

### What labels are required for each issue?

Expand All @@ -178,7 +181,7 @@ The `type` labels are exclusive of each other: each sorted issue should have exa

The `source` labels are exclusive of each other: each sorted issue should have exactly one `source` label. These labels give information on the sub-group to which the issue's author belongs (_e.g._, a partner, a frequent contributor, the wider community, etc.). Through these labels, maintainers gain insight into how well we're meeting the needs of various groups.

The `severity` labels are exclusive of each other and, while required for the [`type::bug`](https://github.com/conda/infrastructure/labels/type%3A%bug) label, they can also be applied to other types to indicate demand or need. These labels help us to prioritize our work. Severity is not the only factor for work prioritization, but it is an important consideration.
The `severity` labels are exclusive of each other and, while required for the https://github.com/conda/infrastructure/labels/type%3A%bug label, they can also be applied to other types to indicate demand or need. These labels help us to prioritize our work. Severity is not the only factor for work prioritization, but it is an important consideration.

Please review the descriptions of the `type`, `source`, and `severity` labels on the [labels page][labels-page] prior to use.

Expand Down Expand Up @@ -213,7 +216,9 @@ Below are some boilerplate responses for the most commonly-seen issues to be sor
This is a duplicate of <b>[link to primary issue]</b>; please feel free to continue the discussion there.
</pre>

> [!WARNING]
<!-- nested admonitions do not render -->
<!-- see https://github.com/orgs/community/discussions/16925#discussioncomment-9542248 -->
> **Warning**
> Apply the https://github.com/conda/infrastructure/labels/duplicate label to the issue being closed and https://github.com/conda/infrastructure/labels/duplicate%3A%3Aprimary to the original issue.
</details>
Expand All @@ -231,8 +236,10 @@ support:
- [Anaconda issue tracker on GitHub](https://github.com/ContinuumIO/anaconda-issues/issues)
</pre>

> [!WARNING]
> Apply the https://github.com/conda/infrastructure/labels/off-topic label to these issues before closing them out.
<!-- nested admonitions do not render -->
<!-- see https://github.com/orgs/community/discussions/16925#discussioncomment-9542248 -->
> **Warning**
> Apply the https://github.com/conda/infrastructure/labels/off-topic label to these issues before closing them out.
</details>

Expand All @@ -248,11 +255,14 @@ Community support can be found elsewhere, though, and we encourage you to explor
- [Stack Overflow posts tagged "conda"](https://stackoverflow.com/questions/tagged/conda)
</pre>

> [!WARNING]
<!-- nested admonitions do not render -->
<!-- see https://github.com/orgs/community/discussions/16925#discussioncomment-9542248 -->
> **Warning**
> Apply the https://github.com/conda/infrastructure/labels/off-topic label to these issues before closing them out.
</details>


In order to not have to manually type or copy/paste the above repeatedly, note that it's possible to add text for the most commonly-used responses via [GitHub's "Add Saved Reply" option][docs-saved-reply].

## Commit Signing
Expand Down
Loading

0 comments on commit fc7029a

Please sign in to comment.