mirror of
https://github.com/Cuprate/cuprate.git
synced 2024-11-16 15:58:17 +00:00
repo: add issue templates (#137)
* add issue templates * add `question.md` * fix bug.md * fix feature.md * bug.md: fix spacing
This commit is contained in:
parent
4876e159e7
commit
d052fbedf1
5 changed files with 123 additions and 0 deletions
45
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
45
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
name: 🐞 Bug report
|
||||
about: Create a bug report
|
||||
title: ''
|
||||
labels: ["C-bug"]
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Notes:
|
||||
- All these fields are optional, add as much or as little info as you like
|
||||
- Please search to see if an issue already exists for the bug you encountered
|
||||
-->
|
||||
|
||||
## Environment
|
||||
Example:
|
||||
- OS: Windows 11
|
||||
- CPU: AMD Ryzen 5 5600X
|
||||
- Memory: 16GB
|
||||
- Storage: SSD 500GB
|
||||
- Cuprate: v1.0.0
|
||||
|
||||
## Bug
|
||||
What is the bug?
|
||||
|
||||
### Expected behavior
|
||||
What correct beahvior was expected to happen?
|
||||
|
||||
## Steps to reproduce
|
||||
Example:
|
||||
1. In this environment...
|
||||
2. With this config...
|
||||
3. Run '...'
|
||||
4. See error...
|
||||
|
||||
## Log
|
||||
If possible, add any related logs to help explain the bug.
|
||||
|
||||
Note: please remove any sensitive information from the logs (e.g. IP address).
|
||||
|
||||
## Screenshots
|
||||
If possible, add screenshots to help explain the bug.
|
||||
|
||||
Note: please remove any sensitive information from the screenshot.
|
18
.github/ISSUE_TEMPLATE/discussion.md
vendored
Normal file
18
.github/ISSUE_TEMPLATE/discussion.md
vendored
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
name: ⏳ Discussion
|
||||
about: Start a discussion on a topic
|
||||
title: ''
|
||||
labels: ["C-discussion"]
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Note: Please search to see if an issue already exists for this discussion.
|
||||
-->
|
||||
|
||||
## What
|
||||
What would you would like to discuss?
|
||||
|
||||
## Why
|
||||
Why would you would like to discuss this?
|
21
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
name: ✨ Feature request
|
||||
about: Request a feature
|
||||
title: ''
|
||||
labels: ["C-request"]
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Note: Please search to see if an issue already exists for this request, or if the feature already exists.
|
||||
-->
|
||||
|
||||
## Feature
|
||||
What is the feature you're requesting?
|
||||
|
||||
## Why
|
||||
Why should your feature be added?
|
||||
|
||||
## Additional context
|
||||
Add any other context or screenshots about the feature request.
|
24
.github/ISSUE_TEMPLATE/proposal.md
vendored
Normal file
24
.github/ISSUE_TEMPLATE/proposal.md
vendored
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: 📜 Proposal
|
||||
about: Propose an idea and request for comments
|
||||
title: ''
|
||||
labels: ["C-proposal"]
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
|
||||
## How
|
||||
Describe how the proposal could be implemented.
|
15
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
name: ❓ Question
|
||||
about: Ask a question
|
||||
title: ''
|
||||
labels: ["C-question"]
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Note: Please search to see if an issue already exists for this question.
|
||||
-->
|
||||
|
||||
## Question
|
||||
What question would you like to ask?
|
Loading…
Reference in a new issue