-
-
Notifications
You must be signed in to change notification settings - Fork 23
Created ISSUE TEMPLATE folder with BUG-REPORT, DOC-UPDATE, FEATURE REQUEST - GENERAL ISSUE.yaml files #15
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
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
f4cde93
Update README.md
Pritam-Reddy 68bfbea
Merge branch 'yashksaini-coder:main' into main
Pritam-Reddy e62463e
Update auto-comment workflow for PRs and Issues
Pritam-Reddy 6a73e4a
Update autoComment.yaml
Pritam-Reddy fc4fc21
Merge branch 'main' of https://github.com/Pritam-Reddy/Leetcode-Journal
Pritam-Reddy ca7b23d
Update autoComment.yaml
Pritam-Reddy 5043544
added ISSUES Template
Pritam-Reddy 6d066c4
Created PR Template
Pritam-Reddy ce54357
Delete Doc-Update.yaml
Pritam-Reddy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,32 @@ | ||
name: 🐞 Bug | ||
description: Report an issue to help us improve the project. | ||
title: "[BUG] <write a small description here>" | ||
labels: ["bug", "goal: fix", "priority: medium"] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Screenshots | ||
description: Please add screenshots if applicable | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Any additional information? | ||
description: Any additional information or Is there anything we should know about this bug? | ||
validations: | ||
required: false | ||
- type: dropdown | ||
attributes: | ||
label: What browser are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge |
This file contains hidden or 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,67 @@ | ||
name: "📚 Documentation Update" | ||
description: "Help us improve our documentation" | ||
title: "[DOCS] " | ||
labels: ["documentation"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for helping improve our documentation! 📖 | ||
Please fill out the information below to help us understand your suggestion better. | ||
|
||
- type: textarea | ||
id: current_docs | ||
attributes: | ||
label: "Current Documentation" | ||
description: "What's currently in the documentation that needs to be updated?" | ||
placeholder: "Example: The installation guide is missing steps for Windows setup..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: suggested_change | ||
attributes: | ||
label: "Suggested Changes" | ||
description: "What changes would you like to see?" | ||
placeholder: "Example: Add Windows-specific installation steps..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: "Screenshots or Examples" | ||
description: "Add screenshots or examples if applicable" | ||
placeholder: "Drag and drop images here..." | ||
|
||
- type: dropdown | ||
id: doc_type | ||
attributes: | ||
label: "Documentation Type" | ||
options: | ||
- Installation Guide | ||
- API Reference | ||
- Tutorials | ||
- README | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: "Contribution Agreement" | ||
options: | ||
- label: "I have searched existing issues and this is not a duplicate" | ||
required: true | ||
- label: "I have read the contributing guidelines" | ||
required: true | ||
- label: "I would like to work on fixing this documentation" | ||
required: false | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
--- | ||
⭐ Thank you for helping make our documentation better! |
This file contains hidden or 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,71 @@ | ||
name: "✨ Feature Request" | ||
description: "Suggest a new feature to enhance our Leetcode-Journal" | ||
title: "[FEATURE] " | ||
labels: ["enhancement"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Feature Request | ||
Thanks for taking the time to suggest a new feature! | ||
Please fill out the information below to help us understand your suggestion better. | ||
|
||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: "Problem Statement" | ||
description: "What problem does this feature solve?" | ||
placeholder: "I'm always frustrated when..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: "Proposed Solution" | ||
description: "Describe the solution you'd like" | ||
placeholder: "It would be great if..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: "Alternative Solutions" | ||
description: "What alternatives have you considered?" | ||
placeholder: "Another approach could be..." | ||
|
||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: "Screenshots or Mockups" | ||
description: "Add any relevant screenshots, mockups or examples" | ||
placeholder: "Drag and drop images here..." | ||
|
||
- type: dropdown | ||
id: priority | ||
attributes: | ||
label: "Priority" | ||
options: | ||
- High | ||
- Medium | ||
- Low | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: "Contribution Guidelines" | ||
options: | ||
- label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) and this is not a duplicate" | ||
required: true | ||
- label: "I would like to implement this feature" | ||
required: false | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
--- | ||
💡 Thank you for contributing to make our Leetcode Journal better! |
This file contains hidden or 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,67 @@ | ||
name: "🤔 General Issue" | ||
description: "Submit a general question, suggestion or issue" | ||
title: "[GENERAL] " | ||
labels: ["triage-needed"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# General Issue Template | ||
Thanks for taking the time to fill out this issue! Please provide as much information as possible. | ||
|
||
- type: dropdown | ||
id: category | ||
attributes: | ||
label: "Category" | ||
description: "What type of issue is this?" | ||
options: | ||
- Question | ||
- Suggestion | ||
- Problem | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Description" | ||
description: "What would you like to share or ask?" | ||
placeholder: "Provide details about your issue, question, or suggestion..." | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: additional | ||
attributes: | ||
label: "Additional Context" | ||
description: "Add any other context, screenshots, or relevant information" | ||
placeholder: "Add any additional details here..." | ||
|
||
- type: dropdown | ||
id: impact | ||
attributes: | ||
label: "Impact Level" | ||
options: | ||
- High | ||
- Medium | ||
- Low | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: "Contribution Guidelines" | ||
options: | ||
- label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) to avoid duplicates" | ||
required: true | ||
- label: "I would like to help resolve this issue" | ||
required: false | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
--- | ||
Thank you for contributing to our project! 🙏 |
This file contains hidden or 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,32 @@ | ||
# Pull Request Template | ||
|
||
## Summary | ||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
|
||
Fixes # (issue) | ||
|
||
## Type of Change | ||
Please mark [X] for applicable items: | ||
|
||
- [ ] 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) | ||
- [ ] Documentation update | ||
- [ ] Code refactoring | ||
- [ ] Other (please describe): | ||
|
||
## Testing | ||
Please describe the tests you performed to verify your changes: | ||
|
||
## Screenshots/Videos | ||
Please attach relevant screenshots or videos demonstrating the changes. | ||
|
||
## Checklist | ||
Please mark [X] for completed items: | ||
|
||
- [ ] My code follows the project's style guidelines | ||
- [ ] I have performed a self-review of my code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have updated the documentation accordingly | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.