You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/triaging/index.qmd
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: "Issue and Discussion Triage"
3
3
description: |
4
4
This guide provides instructions for effectively triaging issues and discussions on Quarto CLI GitHub repository.
5
-
The primary goal is to ensure that all issues and discussions are managed efficiently, helping maintain a clear and organised project workflow.
5
+
The primary goal is to ensure that all issues and discussions are managed efficiently, helping maintain a clear and organized project workflow.
6
6
engine: markdown
7
7
toc-depth: 4
8
8
---
@@ -12,21 +12,21 @@ toc-depth: 4
12
12
### Purpose
13
13
14
14
This guide provides instructions for effectively triaging issues and discussions on a Quarto CLI GitHub repository.
15
-
The primary goal is to ensure that all issues and discussions are managed efficiently, helping maintain a clear and organised project workflow.
15
+
The primary goal is to ensure that all issues and discussions are managed efficiently, helping maintain a clear and organized project workflow.
16
16
17
17
### Scope
18
18
19
19
The document covers the processes for identifying, reviewing, and managing issues and discussions.
20
-
This includes assigning responsibilities, prioritising tasks, and ensuring all issues are directed towards the appropriate project milestones.
20
+
This includes assigning responsibilities, prioritizing tasks, and ensuring all issues are directed towards the appropriate project milestones.
21
21
22
22
### Tech Lead Engagement
23
23
24
24
Tech leads and other maintainers will be actively engaged in the ongoing triage of new project issues.
25
-
Their involvement is crucial to maintaining the project's organisation and ensuring that issues are handled promptly and effectively.
25
+
Their involvement is crucial to maintaining the project's organization and ensuring that issues are handled promptly and effectively.
26
26
27
-
### Organisation of Issues
27
+
### Organization of Issues
28
28
29
-
Issues will be continuously organised into milestones based on a clear [Planning Horizon](#planning-horizon).
29
+
Issues will be continuously organized into milestones based on a clear [Planning Horizon](#planning-horizon).
30
30
This ensures that the team has a structured approach to managing the project's progress and addressing issues in a timely manner.
31
31
32
32
### All Issues and Discussions Managed in Quarto CLI Repository
@@ -67,10 +67,10 @@ All issues beyond the next Milestone will be triaged to the "Future" milestone,
67
67
68
68
- Use clear and consistent labels such as [`bug`](https://github.com/quarto-dev/quarto-cli/labels/bug), [`enhancement`](https://github.com/quarto-dev/quarto-cli/labels/enhancement), [`support`](https://github.com/quarto-dev/quarto-cli/labels/support), [`maintenance`](https://github.com/quarto-dev/quarto-cli/labels/maintenance), and [`documentation`](https://github.com/quarto-dev/quarto-cli/labels/documentation) to define the nature of the issue.
69
69
Issues are expected to have exactly one of these labels.
70
-
- Assign additional [labels](https://github.com/quarto-dev/quarto-cli/labels/) to categorise issues based on their type such as `html`, `website`, `installers`, `crossref`, *etc.*
71
-
- Create custom labels if necessary to better categorise issues.
70
+
- Assign additional [labels](https://github.com/quarto-dev/quarto-cli/labels/) to categories issues based on their type such as `html`, `website`, `installers`, `crossref`, *etc.*
71
+
- Create custom labels if necessary to better categories issues.
72
72
73
-
#### Prioritisation
73
+
#### Prioritization
74
74
75
75
- Assess the severity and impact of issues to determine priority, *e.g.*:
76
76
- use the [`regression` label](https://github.com/quarto-dev/quarto-cli/labels/regression) for bugs that appeared in a recent release
@@ -120,11 +120,11 @@ In such cases, we encourage the following actions:
120
120
121
121
#### Categories
122
122
123
-
- Ensure discussions are categorised based on their nature, such as [`Features Requests`](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests), [`Q&A`](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a), and [`Show and tell`](https://github.com/quarto-dev/quarto-cli/discussions/categories/show-and-tell).
123
+
- Ensure discussions are categorized based on their nature, such as [`Features Requests`](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests), [`Q&A`](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a), and [`Show and tell`](https://github.com/quarto-dev/quarto-cli/discussions/categories/show-and-tell).
124
124
125
125
#### Labels
126
126
127
-
- Assign [labels](https://github.com/quarto-dev/quarto-cli/labels/) to categorise issues based on their type such as `html`, `website`, `installers`, `crossref`, *etc.*
127
+
- Assign [labels](https://github.com/quarto-dev/quarto-cli/labels/) to categorize issues based on their type such as `html`, `website`, `installers`, `crossref`, *etc.*
0 commit comments