Skip to content

Commit

Permalink
doc(): bug format
Browse files Browse the repository at this point in the history
Signed-off-by: Md Imran imranaec@outlook.com
  • Loading branch information
narmidm committed Sep 15, 2023
1 parent ecd88b5 commit ab541b6
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: "🐛 Bug Report"
description: "Submit a bug report to help us improve"
title: "Bug: "
labels: [bug]
assignees: ["narmidm","bharath-avesha","YachikaRalhan","Rahul-D78","rahulsawra98","gourishkb","mridulgain","richiesebastian"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out our bug report form 🙏
- type: textarea
id: description
validations:
required: true
attributes:
label: "📜 Description"
description: "A clear and concise description of what the bug is."
placeholder: "It bugs out when ..."
- type: textarea
id: steps-to-reproduce
validations:
required: true
attributes:
label: "👟 Reproduction steps"
description: "How do you trigger this bug? Please walk us through it step by step."
placeholder: "1. When I ..."
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: "👍 Expected behavior"
description: "What did you think would happen?"
placeholder: "It should ..."
- type: textarea
id: actual-behavior
validations:
required: true
attributes:
label: "👎 Actual Behavior"
description: "What did actually happen? Add screenshots, if applicable."
placeholder: "It actually ..."
- type: textarea
id: logs
attributes:
label: "🐚 Relevant log output"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
placeholder: "It used ...."
- type: dropdown
id: os
attributes:
label: "🖥️ What operating system are you seeing the problem on?"
multiple: true
options:
- Linux
- MacOS
- Windows
- type: textarea
id: solution
validations:
required: false
attributes:
label: "✅ Proposed Solution"
description: "Any thoughts as to potential solutions or ideas to go about finding one. Please include links to any research."
placeholder: "To fix this, I found ..."
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you spent some time to check if this issue has been raised before?"
description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
options:
- label: "I checked and didn't find any similar issue"
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: I have read the [https://github.com/kubeslice/worker-operator/blob/master/code_of_conduct.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 🚀 Feature
description: "Submit a proposal for a new feature"
title: "Feature: "
labels: [feature]
assignees: ["narmidm","bharath-avesha","YachikaRalhan","Rahul-D78","rahulsawra98","gourishkb","mridulgain","richiesebastian"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out our feature request form 🙏
- type: textarea
id: feature-description
validations:
required: true
attributes:
label: "🔖 Feature description"
description: "A clear and concise description of what the feature is."
placeholder: "You should add ..."
- type: textarea
id: pitch
validations:
required: true
attributes:
label: "🎤 Pitch"
description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable."
placeholder: "In my use-case, ..."
- type: textarea
id: solution
validations:
required: true
attributes:
label: "✌️ Solution"
description: "A clear and concise description of what you want to happen."
placeholder: "I want this feature to, ..."
- type: textarea
id: alternative
validations:
required: false
attributes:
label: "🔄️ Alternative"
description: "A clear and concise description of any alternative solutions or features you've considered."
placeholder: "I tried, ..."
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you spent some time to check if this issue has been raised before?"
description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
options:
- label: "I checked and didn't find similar issue"
required: true
- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Code of Conduct?"
options:
- label: "I have read the [Code of Conduct](https://github.com/kubeslice/worker-operator/blob/master/code_of_conduct.md)"
required: true

0 comments on commit ab541b6

Please sign in to comment.