Skip to content

Commit

Permalink
Merge pull request #8 from vishalda/issue-template
Browse files Browse the repository at this point in the history
Added Issue templates and pull request template Issue:#6
  • Loading branch information
kamleshjoshi8102 authored Oct 3, 2021
2 parents aff3f16 + 36b8a20 commit 9194676
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug report
description: Create a report to help us improve
title: "[Bug]: "
labels: [bug, Priority-High, want fix, Review Required]
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is
validations:
required: false
- type: textarea
attributes:
label: To Reproduce
description: |
Steps to reproduce the behavior.
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Screenshot/ Video
description: If applicable, add screenshots to help explain your problem.
validations:
required: false
- type: textarea
attributes:
label: Desktop (please complete the following information)
description: |
Device - [e.g. iPhone6]
OS - [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Documentation request
description: Change regarding improvising the docs to be more accessible
title: "[Doc]: "
labels: [documentation, enhancement, good first issue]
body:
- type: checkboxes
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is
options:
- label: Information addition regarding the newest change through a PR.
- label: Typo error.
- label: New category addition.
- label: Refractoring sentences that make more sense.
- label: Fixing broken links.
- label: Refractors / reformating of the document.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature]: "
labels: [feature, Review Required]
body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
placeholder: Ex. I'm always frustated when [...]
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: false
- 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 or screenshots about the feature request here.
validations:
required: false
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--Type in all the issues that have been fixed through this pull request ex : #1 -->

## Fixes Issue

This PR fixes the following issues:

#example

<!-- Write down all the changes made-->

## Changes proposed

Here comes all the changes proposed through this PR

<!-- Check all the boxes which are applicable to check the box correct follow the following conventions-->
<!--
[x] - Correct
[X] - Correct
-->

## Check List (Check all the boxes which are applicable) <!--Follow the above conventions to check the box-->

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] All new and existing tests passed.
- [ ] This PR does not contain plagiarized content.
- [ ] The title of my pull request is a short description of the requested changes.

<!--Add screen shots of the changed output-->

## Screenshots

Add all the screenshots which support your changes

0 comments on commit 9194676

Please sign in to comment.