From f6c4e4e9a8b0d2e5e6d6f0e20b2b3115b427c242 Mon Sep 17 00:00:00 2001
From: hinto-janai <hinto.janai@protonmail.com>
Date: Thu, 20 Jun 2024 18:27:09 -0400
Subject: [PATCH] repo: add `Tracking Issue` issue template (#182)

* add `tracking_issue.md`

* fix `{bug,proposal}.md`

* format `tracking_issue.md`
---
 .github/ISSUE_TEMPLATE/bug.md            |  2 +-
 .github/ISSUE_TEMPLATE/proposal.md       |  6 ++--
 .github/ISSUE_TEMPLATE/tracking_issue.md | 41 ++++++++++++++++++++++++
 3 files changed, 45 insertions(+), 4 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/tracking_issue.md

diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
index 404bd6ad..a0fdbcba 100644
--- a/.github/ISSUE_TEMPLATE/bug.md
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -24,7 +24,7 @@ Example:
 ## Bug
 What is the bug?
 
-### Expected behavior
+## Expected behavior
 What correct beahvior was expected to happen?
 
 ## Steps to reproduce
diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
index 132b2b07..777cf3e2 100644
--- a/.github/ISSUE_TEMPLATE/proposal.md
+++ b/.github/ISSUE_TEMPLATE/proposal.md
@@ -14,11 +14,11 @@ Note: Please search to see if an issue already exists for this proposal.
 ## What
 Describe your proposal.
 
-## Where
-Describe where your proposal will cause changes to.
-
 ## Why
 Describe why the proposal is needed.
 
+## Where
+Describe where your proposal will cause changes to.
+
 ## How
 Describe how the proposal could be implemented.
diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.md b/.github/ISSUE_TEMPLATE/tracking_issue.md
new file mode 100644
index 00000000..d9423b41
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/tracking_issue.md
@@ -0,0 +1,41 @@
+---
+name: 🔍 Tracking Issue
+about: Create an issue that tracks a wider effort
+title: 'Tracking Issue for ...'
+labels: ["C-tracking-issue"]
+assignees: ''
+
+---
+
+<!-- Consider keeping the following section in the issue. -->
+### About tracking issues
+Tracking issues are used to record the overall progress of implementation.
+They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
+A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
+Instead, open a dedicated issue for the specific matter.
+
+### What
+This is a tracking issue for ...
+
+### Steps
+<!--
+Describe the steps required to bring this effort to completion.
+
+For larger features, more steps might be involved.
+If the feature is changed later, please add those PRs here as well.
+-->
+
+- [ ] Initial implementation: #...
+- [ ] Other code: #...
+- [ ] Multi-PR effort
+    - #...
+    - #...
+    - #...
+- [ ] Finalization PR: #...
+
+### Related
+<!-- Link any related issues/PRs here. -->
+
+- #...
+- #...
+- #...