Skip to content

repo: add Tracking Issue issue template #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Example:
## Bug
What is the bug?

### Expected behavior
## Expected behavior
What correct beahvior was expected to happen?

## Steps to reproduce
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/tracking_issue.md
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are ### instead of ## like other issue templates because:

  1. rust-lang/rust does it like this
  2. It makes this template stand-out

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

- #...
- #...
- #...
Loading