Skip to content

Commit

Permalink
Merge pull request #45 from prathamesh-borse/Template
Browse files Browse the repository at this point in the history
Added ISSUE and PR Templates for Helping Beginners.
  • Loading branch information
prathamesh-borse authored Oct 4, 2021
2 parents 6f0751d + 603c49b commit 9a801f5
Show file tree
Hide file tree
Showing 6 changed files with 150 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug report
description: Create a report to help us address an error.
title: "[BUG] - "
labels: ["🚦 status: awaiting triage"]
assignees: prathamesh-borse
body:
- type: markdown
attributes:
value: '# Bug report'
- type: textarea
id: bugdescription
attributes:
label: What bug did you encounter?
description: |
Please provide a clear description of the bug.
Include the steps you took to cause the bug, and an explanation of what occurred.
validations:
required: true
- type: textarea
id: behaviour
attributes:
label: What did you expect to happen?
description: What did you expect to happen instead of the current behaviour?
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Attach any relevant screenshots here.
validations:
required: false
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
validations:
required: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/chore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Chore
description: For requesting chores, such as cleaning up code.
title: "[CHORE] - "
labels: ["🚦 status: awaiting triage"]
assignees: prathamesh-borse
body:
- type: markdown
attributes:
value: "# Chore request"
- type: textarea
id: description
attributes:
label: What work needs to be performed?
description: Provide a clear and concise explanation of the work to be performed.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this chore?
validations:
required: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation
description: Request an update to invalid/outdated documentation
title: "[DOC] - "
labels: ["🚦 status: awaiting triage"]
assignees: prathamesh-borse
body:
- type: markdown
attributes:
value: "# Incorrect Documentation"
- type: textarea
id: docerrordescription
attributes:
label: What is incorrect in the documentation?
description: Please explain the information that is incorrect in the documentation, and why you think it needs to be updated.
validations:
required: true
- type: textarea
id: expectedinformation
attributes:
label: What should that text say?
description: Provide the information that the documentation should actually contain instead of the incorrect content.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this inaccuracy?
validations:
required: false
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature request
description: Suggest an idea for this project
title: "[FEAT] - "
labels: ["🚦 status: awaiting triage"]
assignees: "prathamesh-borse"
body:
- type: markdown
attributes:
value: "# Feature request"
- type: textarea
id: feature
attributes:
label: What feature would you like to see?
description: Be as detailed as possible here. What would you like this application to do? How should you, as a user, interact with this feature?
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this feature?
validations:
required: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Other
description: Use this for any other issues. PLEASE do not create blank issues
title: "[OTHER] - "
labels: ["🚦 status: awaiting triage"]
assignees: prathamesh-borse
body:
- type: markdown
attributes:
value: "# Other issue"
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Pull Request

<!--Before contributing, please read our contributing guidelines-->

## Description:

<!--A brief description of what your pull request does.-->

## Related Issue:

<!--Is this related to an issue? Does it close one? If so, replace the XXXXX below with the issue number.-->

Closes #XXXXX

0 comments on commit 9a801f5

Please sign in to comment.