-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #57 from Sibam-Paul/Docs/Issue-PR-template
Adding ISSUE and PR template [ISSUE-#18]
- Loading branch information
Showing
4 changed files
with
140 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
name: Bug report 🐞 | ||
description: File a bug report | ||
title: "[Bug]: " | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: A concise description of what you are experiencing. | ||
placeholder: Tell us what you see! | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Add ScreenShots | ||
description: Add sufficient ScreenShots to explain your issue. | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: What browsers are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I agree to follow this project's Code of Conduct" | ||
required: true | ||
- label: "I want to work on this issue" | ||
required: False | ||
- label: "I'm willing to provide further clarification or assistance if needed." | ||
required: False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: 📝 Documentation Update | ||
description: Improve Documentation | ||
title: "[Documentation Update]: " | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the updates you want to make. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: issue-description | ||
attributes: | ||
label: Issue Description | ||
description: Please provide a clear description of the documentation update you are suggesting. | ||
placeholder: Describe the improvement or correction you'd like to see in the documentation. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-change | ||
attributes: | ||
label: Suggested Change | ||
description: Provide details of the proposed change to the documentation. | ||
placeholder: Explain how the documentation should be updated or corrected. | ||
validations: | ||
required: true | ||
|
||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I agree to follow this project's Code of Conduct" | ||
required: true | ||
- label: "I want to work on this issue" | ||
required: False | ||
- label: "I'm willing to provide further clarification or assistance if needed." | ||
required: False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: ✨ Feature Request | ||
description: Suggest a feature | ||
title: "[Feature Request]: " | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for this feature. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Feature Description | ||
description: Please provide a detailed description of the feature you are requesting. | ||
placeholder: Describe the new feature or enhancement you'd like to see. | ||
validations: | ||
required: true | ||
|
||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I agree to follow this project's Code of Conduct" | ||
required: true | ||
- label: "I want to work on this issue" | ||
required: False | ||
- label: "I'm willing to provide further clarification or assistance if needed." | ||
required: False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Pull Request Template --> | ||
|
||
## Related Issue* | ||
|
||
Closes #issue_number | ||
|
||
<!-- If there is no issue number, the PR will not be merged. Therefore, please ensure that the issue number is added --> | ||
|
||
## Description | ||
|
||
<!-- Write a brief description of the changes made in the PR. Explain the problem being addressed, or any relevant | ||
information. --> | ||
|
||
## Screenshot Section | ||
|
||
<!-- Include the screenshot to preview the changes done and their proper functionality --> | ||
|
||
## Demo Video Section* | ||
|
||
<!-- Include the demo video to preview the changes done and their proper functionality --> |