Skip to content

Added Templates for Issues. #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SohamTilekar wants to merge 5 commits into from
Closed

Added Templates for Issues. #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7424984
Create bug_report.md
SohamTilekar Jan 28, 2024
461556d
Create enhancement-proposal-template.md
SohamTilekar Jan 28, 2024
71b5352
Create feature_request.md
SohamTilekar Jan 28, 2024
aa732db
Update bug_report.md
SohamTilekar Jan 28, 2024
9f1bab0
Fix the typo in the folder name
SohamTilekar Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE /bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: 'BUG: -'
labels: bug
assignees: ''

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Do this '...'
2. Do that '...'
3. ...

**Trace Back**
```
...
```

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

**Media**
If applicable, add Media to help explain your problem. [e.g. input.mp4]

**Desktop (please complete the following information):**
- OS: [e.g. ubuntu]
- Python Version: [e.g. 3.11]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE /enhancement-proposal-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Enhancement Proposal Template
about: " A structured format for proposing and discussing improvements to the vidiopy
Python module."
title: 'Enhancement Proposal: -'
labels: enhancement
assignees: ''

---

## Enhancement Proposal

**Description:**
A clear and concise description of the enhancement you are proposing.

**Current Behavior:**
Describe the current behavior or limitations that this enhancement aims to address.

**Proposed Changes:**
Outline the changes you propose to make.

**Benefits:**
Explain the benefits of implementing this enhancement.

**Additional Information:**
Any additional context or considerations.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE /feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'FEATURE REQUEST: - '
labels: enhancement, feature request
assignees: ''

---

## Feature Request

**Description:**
A clear and concise description of the feature you'd like to see implemented.

**Use Case:**
Describe the context in which this feature would be used.

**Proposed Solution:**
If you have any initial thoughts on how this feature could be implemented, please share them here.

**Additional Information:**
Any additional context or screenshots that might be helpful.