Skip to content

Commit 1776696

Browse files
authored
docs: Update of the issue and PR templates (#330)
* docs: Update of the issue and PR templates Signed-off-by: Oleg Kopysov <[email protected]> * Removed unnecessary template Signed-off-by: Oleg Kopysov <[email protected]> --------- Signed-off-by: Oleg Kopysov <[email protected]>
1 parent 78c048e commit 1776696

File tree

5 files changed

+52
-37
lines changed

5 files changed

+52
-37
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
---
2-
name: Bug report
2+
name: Bug Report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: bug
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
## Bug Report
1211

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
12+
**Description:**
13+
A clear and concise description of the issue you are experiencing.
1914

20-
**Expected behavior**
15+
**Steps to Reproduce:**
16+
1. Step 1
17+
2. Step 2
18+
3. ...
19+
20+
**Expected Behavior:**
2121
A clear and concise description of what you expected to happen.
2222

23-
**Screenshots**
23+
**Screenshots:**
2424
If applicable, add screenshots to help explain your problem.
2525

26-
**Test environment configuration (please complete the following information):**
27-
* Java: (e.g., Docker and Go versions)
26+
**Test Environment Configuration:**
27+
Please complete the following information):
28+
* Java: (e.g., Docker version)
2829
* LPVS Release: (e.g., 1.0.0)
2930

3031
**Additional context**

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: ''
5+
labels: new feature
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## Feature Request
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
**Description:**
13+
A clear and concise description of the feature you are requesting.
1514

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
15+
**Use Case:**
16+
Describe the use case or problem you are trying to solve with this feature.
1817

19-
**Additional context**
18+
**Additional Information:**
2019
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/task.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Task
3+
about: Create a task for the project
4+
title: ''
5+
labels: task
6+
assignees: ''
7+
---
8+
9+
## Task
10+
11+
**Description:**
12+
A clear and concise description of the task.
13+
14+
**Subtasks:**
15+
- [ ] Subtask 1
16+
- [ ] Subtask 2
17+
- ...
18+
19+
**Additional Information:**
20+
Add any other context or details about the task.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Description
1+
# Pull Request
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed. Also, provide relevant motivation and context. List any dependencies that are required for this change.
46

57
Fixes # (issue)
68

@@ -17,8 +19,9 @@ Please delete options that are not relevant.
1719
- [ ] CI system update
1820
- [ ] Test Coverage update
1921

20-
# How Has This Been Tested?
21-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Below is just an example and you can delete it when you contribute.
22+
## Testing
23+
24+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
2225

2326
**Test Configuration**:
2427
* Java: v11
@@ -27,6 +30,8 @@ Please describe the tests that you ran to verify your changes. Provide instructi
2730
# Checklist:
2831

2932
- [ ] My code follows the style guidelines of this project
33+
- [ ] My code meets the required code coverage for lines (90% and above)
34+
- [ ] My code meets the required code coverage for branches (80% and above)
3035
- [ ] I have performed a self-review of my own code
3136
- [ ] I have commented my code, particularly in hard-to-understand areas
3237
- [ ] I have made corresponding changes to the documentation

0 commit comments

Comments
 (0)