8000 Changes to readme and setup files. by codeAshu · Pull Request #3 · video-db/videodb-python · GitHub
[go: up one dir, main page]

Skip to content

Changes to readme and setup files. #3

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.

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

Merged
merged 2 commits into from
Dec 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
8000
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug report
description: Create a report to help us improve
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Confirm this is a new bug report
description: >
Select the checkboxes that apply to this bug report. If you're not sure about any of these, don't worry! We'll help you figure it out.
options:
- label: Possible new bug in VideoDB Python Client
required: false
- label: Potential new bug in VideoDB API
required: false
- label: I've checked the current issues, and there's no record of this bug
required: true
- type: textarea
attributes:
label: Current Behavior
description: >
A clear and concise description of what the bug is.
placeholder: >
I intended to perform action X, but unexpectedly encountered outcome Y.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: >
A clear and concise description of what you expected to happen.
placeholder: >
I expected outcome Y to occur.
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: >
Steps to reproduce the behavior:
placeholder: |
1. Fetch a '...'
2. Update the '....'
3. See error
validations:
required: true
- type: textarea
attributes:
label: Relevant Logs and/or Screenshots
description: >
If applicable, add logs and/or screenshots to help explain your problem.
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
Please complete the following information:
eg:
- OS: Ubuntu 20.04
- Python: 3.9.1
- Videodb: 0.0.1
value: |
- OS:
- Python:
- Videodb:
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: >
Add any other context about the problem here.
validations:
required: false

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature
description: Submit a proposal/request for a new feature
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: checkboxes
attributes:
label: Confirm this is a new feature request
description: >
Select the checkboxes that apply to this feature request. If you're not sure about any of these, don't worry! We'll help you figure it out.
options:
- label: Possible new feature in VideoDB Python Client
required: false
- label: Potential new feature in VideoDB API
required: false
- label: I've checked the current issues, and there's no record of this feature request
required: true
- type: textarea
attributes:
label: Describe the feature
description: >
A clear and concise description of what the feature is and why it's needed.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: |
A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: >
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: >
Add any other context about the feature request here.
validations:
required: false
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Pull Request

**Description:**
Describe the purpose of this pull request.

**Changes:**
- [ ] Feature A
- [ ] Bugfix B

**Related Issues:**
- Closes #123
- Addresses #456

**Testing:**
Describe any testing steps that have been taken or are necessary.
Make sure to take in account any existing code change that require some feature to be re-tested.


**Checklist:**
- [ ] Code follows project coding standards
- [ ] Tests have been added or updated
- [ ] Code Review
- [ ] Manual test after merge
- [ ] All checks passed
Loading
0