Skip to content

Commit

Permalink
added ISSUES Template
Browse files Browse the repository at this point in the history
  • Loading branch information
Pritam-Reddy committed Jan 5, 2025
1 parent ca7b23d commit 5043544
Show file tree
Hide file tree
Showing 4 changed files with 237 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug-report.yaml
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
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/Doc-Update.yaml
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!
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature-Request.yaml
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!
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/General_issue.yaml
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! 🙏

0 comments on commit 5043544

Please sign in to comment.