repo: add Tracking Issue issue template (#182)
Some checks failed
Audit / audit (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
Deny / audit (push) Has been cancelled

* add `tracking_issue.md`

* fix `{bug,proposal}.md`

* format `tracking_issue.md`
This commit is contained in:
hinto-janai 2024-06-20 18:27:09 -04:00 committed by GitHub
parent bef2a2cbd4
commit f6c4e4e9a8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 45 additions and 4 deletions

View file

@ -24,7 +24,7 @@ Example:
## Bug ## Bug
What is the bug? What is the bug?
### Expected behavior ## Expected behavior
What correct beahvior was expected to happen? What correct beahvior was expected to happen?
## Steps to reproduce ## Steps to reproduce

View file

@ -14,11 +14,11 @@ Note: Please search to see if an issue already exists for this proposal.
## What ## What
Describe your proposal. Describe your proposal.
## Where
Describe where your proposal will cause changes to.
## Why ## Why
Describe why the proposal is needed. Describe why the proposal is needed.
## Where
Describe where your proposal will cause changes to.
## How ## How
Describe how the proposal could be implemented. Describe how the proposal could be implemented.

View file

@ -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. -->
- #...
- #...
- #...