Skip to content

Commit

Permalink
docs: Update of the issue and PR templates (#330)
Browse files Browse the repository at this point in the history
* docs: Update of the issue and PR templates

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>

* Removed unnecessary template

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>

---------

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
  • Loading branch information
o-kopysov committed Nov 30, 2023
1 parent 78c048e commit 1776696
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 37 deletions.
29 changes: 15 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
---
name: Bug report
name: Bug Report
about: Create a report to help us improve
title: ''
labels: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
## Bug Report

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Description:**
A clear and concise description of the issue you are experiencing.

**Expected behavior**
**Steps to Reproduce:**
1. Step 1
2. Step 2
3. ...

**Expected Behavior:**
A clear and concise description of what you expected to happen.

**Screenshots**
**Screenshots:**
If applicable, add screenshots to help explain your problem.

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

**Additional context**
Expand Down
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

17 changes: 8 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
name: Feature request
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: ''
labels: new feature
assignees: ''

---

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

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

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

**Additional context**
**Additional Information:**
Add any other context or screenshots about the feature request here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Task
about: Create a task for the project
title: ''
labels: task
assignees: ''
---

## Task

**Description:**
A clear and concise description of the task.

**Subtasks:**
- [ ] Subtask 1
- [ ] Subtask 2
- ...

**Additional Information:**
Add any other context or details about the task.
13 changes: 9 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Description
# Pull Request

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.
## Description

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.

Fixes # (issue)

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

# How Has This Been Tested?
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.
## Testing

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.

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

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

0 comments on commit 1776696

Please sign in to comment.