Skip to content

Commit

Permalink
🚀feat: added issue and PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushsoni1010 committed Dec 5, 2021
1 parent bd1cf1c commit 774795e
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Bug report
description: Create a report to help us improve. Report bugs found while using the project
title: "[BUG] <description>"
labels: ["🛠 goal: fix"]
body:
- type: textarea
id: actualbhv
attributes:
label: "🙁 Actual behavior"
description: What happened, and why it was wrong
validations:
required: true
- type: textarea
id: expectedbhv
attributes:
label: "🙂 Expected behavior"
description: What you expected to happen instead, and why
validations:
required: true
- type: textarea
id: steps
attributes:
label: "🔢 Steps to Reproduce the Problem"
description: If possible, provide steps to reproduce the problem you're experiencing
placeholder: |
1. First step
2. Second step
3. Third step
validations:
required: false
- type: markdown
attributes:
value: |
You can also join the Discord community [here](https://discord.gg/HPZzuJs3VY)
Feel free to check out other cool repositories of the The Gita Initiative Communtiy [here](https://github.com/gita)
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest features, propose improvements, discuss new ideas
title: "[FEATURE] <description>"
labels: ["⭐ goal: addition"]
body:
- type: textarea
id: suggestion
attributes:
label: ⭐ Suggestion
description: A summary of what you'd like to see added or changed
validations:
required: true
- type: textarea
id: usecases
attributes:
label: 💻 Use Cases
description: |
What are possible you cases for your suggested feature?
Are you using any workarounds in the meantime?
validations:
required: false
- type: textarea
id: relatedproblems
attributes:
label: ❌ Related Problems
description: |
Is your Request related to a problem?
Think about linking existing Issues here!
validations:
required: false
- type: markdown
attributes:
value: |
You can also join the Discord community [here](https://discord.gg/HPZzuJs3VY)
Feel free to check out other cool repositories of the The Gita Initiative Communtiy [here](https://github.com/gita)
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Other
description: Use this for any other issues. PLEASE do not create blank issues
title: "[OTHER]"
labels: ["🚦 status: awaiting triage"]
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
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Description

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.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update


# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] 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
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

0 comments on commit 774795e

Please sign in to comment.