mirror of
https://github.com/Cuprate/cuprate.git
synced 2024-11-16 15:58:17 +00:00
repo: add Tracking Issue
issue template (#182)
Some checks are pending
Audit / audit (push) Waiting to run
CI / fmt (push) Waiting to run
CI / typo (push) Waiting to run
CI / ci (macos-latest, stable, bash) (push) Waiting to run
CI / ci (ubuntu-latest, stable, bash) (push) Waiting to run
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Waiting to run
Deny / audit (push) Waiting to run
Some checks are pending
Audit / audit (push) Waiting to run
CI / fmt (push) Waiting to run
CI / typo (push) Waiting to run
CI / ci (macos-latest, stable, bash) (push) Waiting to run
CI / ci (ubuntu-latest, stable, bash) (push) Waiting to run
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Waiting to run
Deny / audit (push) Waiting to run
* add `tracking_issue.md` * fix `{bug,proposal}.md` * format `tracking_issue.md`
This commit is contained in:
parent
bef2a2cbd4
commit
f6c4e4e9a8
3 changed files with 45 additions and 4 deletions
2
.github/ISSUE_TEMPLATE/bug.md
vendored
2
.github/ISSUE_TEMPLATE/bug.md
vendored
|
@ -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
|
||||||
|
|
6
.github/ISSUE_TEMPLATE/proposal.md
vendored
6
.github/ISSUE_TEMPLATE/proposal.md
vendored
|
@ -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.
|
||||||
|
|
41
.github/ISSUE_TEMPLATE/tracking_issue.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/tracking_issue.md
vendored
Normal 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. -->
|
||||||
|
|
||||||
|
- #...
|
||||||
|
- #...
|
||||||
|
- #...
|
Loading…
Reference in a new issue