Skip to content

Commit eb1cb52

Browse files
authored
chore: add PR and issues templates (#111)
1 parent ed6e1ac commit eb1cb52

File tree

5 files changed

+101
-0
lines changed

5 files changed

+101
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "\U0001F41B Bug Report"
3+
about: As a User, I want to report a Bug.
4+
labels: type/bug
5+
---
6+
7+
## Bug Report
8+
9+
Please answer these questions before submitting your issue. Thanks!
10+
11+
### 1. Minimal reproduce step (Required)
12+
13+
<!-- a step by step guide for reproducing the bug. -->
14+
15+
### 2. What did you expect to see? (Required)
16+
17+
### 3. What did you see instead (Required)
18+
19+
### 4. What is your Vanus version? (Required)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "\U0001F680 Enhancement"
3+
about: As a Vanus developer, I want to make an enhancement.
4+
labels: type/enhancement
5+
---
6+
7+
## Enhancement
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: As a user, I want to request a New Feature on the product.
4+
labels: type/feature-request
5+
---
6+
7+
## Feature Request
8+
9+
**Is your feature request related to a problem? Please describe:**
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
11+
12+
**Describe the feature you'd like:**
13+
<!-- A clear and concise description of what you want to happen. -->
14+
15+
**Describe alternatives you've considered:**
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
17+
18+
**Teachability, Documentation, Adoption, Migration Strategy:**
19+
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "\U0001F914 Ask a Question"
3+
about: I want to ask a question.
4+
labels: type/question
5+
---
6+
7+
## Question
8+
9+
<!--
10+
11+
Before asking a question, make sure you have:
12+
13+
- Searched existing Stack Overflow questions.
14+
- Googled your question.
15+
- Searched open and closed [GitHub issues](https://github.com/linkall-labs/vanus/issues)
16+
- Read the documentation:
17+
- [Vanus Readme](https://github.com/linkall-labs/vanus)
18+
- [Vanus Docs](https://github.com/linkall-labs/docs)
19+
20+
-->

.github/pull_request_template.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
3+
Thank you for contributing to Vanus!
4+
5+
PR Title Format:
6+
7+
feat/fix/refactor/docs/...: what's changed
8+
9+
Note: see https://github.com/linkall-labs/vanus/blob/main/CONTRIBUTING.md to know details about title format
10+
-->
11+
12+
### What problem does this PR solve?
13+
<!--
14+
15+
Please create an issue first to describe the problem
16+
17+
There MUST be one line starting with "Issue Number: ".
18+
19+
-->
20+
21+
Issue Number: close #xxx
22+
23+
Problem Summary:
24+
25+
### What is changed and how it works?
26+
27+
### Check List
28+
29+
<!-- At least one of them must be included. -->
30+
31+
#### Tests
32+
- [ ] Unit test
33+
- [ ] Integration test
34+
- [ ] Manual test (add detailed scripts or steps below)
35+
- [ ] No code
36+

0 commit comments

Comments
 (0)