From cd5ec6c59797b08513842a6c2ca8ea160644dbe4 Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Thu, 20 Jun 2024 12:25:01 -0400 Subject: [PATCH 1/3] add `tracking_issue.md` --- .github/ISSUE_TEMPLATE/tracking_issue.md | 54 ++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/tracking_issue.md diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.md b/.github/ISSUE_TEMPLATE/tracking_issue.md new file mode 100644 index 000000000..60376617b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tracking_issue.md @@ -0,0 +1,54 @@ +--- +name: 🔍 Tracking Issue +about: Create an issue that tracks an effort or PR(s) +title: 'Tracking Issue for ...' +labels: ["C-tracking-issue"] +assignees: '' + +--- + + + +## What +Describe the effort being tracked. + +## Why +Describe why this effort is needed. + +## Where +Describe where changes will be made. + +## How +If possible, describe how the effort could be implemented. + +Include a summarized version of the public API, e.g. +just the function signatures without their doc comments or implementation. + +```rust +// core::magic + +pub struct Magic; + +impl Magic { + pub fn magic(self); +} +``` + +## 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: #... +- [ ] Finalization PR: #... From 97a5d54bdfad938268ff5da2a52ad56b32363972 Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Thu, 20 Jun 2024 12:25:11 -0400 Subject: [PATCH 2/3] fix `{bug,proposal}.md` --- .github/ISSUE_TEMPLATE/bug.md | 2 +- .github/ISSUE_TEMPLATE/proposal.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 404bd6adc..a0fdbcba2 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 132b2b072..777cf3e24 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. From 441949ec418451f9aaa4975673c4d9b96fdd9686 Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Thu, 20 Jun 2024 12:36:30 -0400 Subject: [PATCH 3/3] format `tracking_issue.md` --- .github/ISSUE_TEMPLATE/tracking_issue.md | 51 +++++++++--------------- 1 file changed, 19 insertions(+), 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.md b/.github/ISSUE_TEMPLATE/tracking_issue.md index 60376617b..d9423b41c 100644 --- a/.github/ISSUE_TEMPLATE/tracking_issue.md +++ b/.github/ISSUE_TEMPLATE/tracking_issue.md @@ -1,54 +1,41 @@ --- name: 🔍 Tracking Issue -about: Create an issue that tracks an effort or PR(s) +about: Create an issue that tracks a wider effort title: 'Tracking Issue for ...' labels: ["C-tracking-issue"] assignees: '' --- - +### 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 -Describe the effort being tracked. - -## Why -Describe why this effort is needed. - -## Where -Describe where changes will be made. - -## How -If possible, describe how the effort could be implemented. -Include a summarized version of the public API, e.g. -just the function signatures without their doc comments or implementation. +### What +This is a tracking issue for ... -```rust -// core::magic - -pub struct Magic; - -impl Magic { - pub fn magic(self); -} -``` - -## Steps +### Steps + - [ ] Initial implementation: #... - [ ] Other code: #... +- [ ] Multi-PR effort + - #... + - #... + - #... - [ ] Finalization PR: #... + +### Related + + +- #... +- #... +- #...