Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Bug Report
description: Report a bug
title: "[Bug]: "
type: bug
body:
- type: markdown
attributes:
value: |
Please read [this](https://engineering.hmn.md/projects/support/) before proceeding forward.
Please note that we don't offer detailed end-user support.
This template is just for bug reports, not for questions.
If the opened issue doesn't have all of the needed information, or it's off-topic, we will close it.
Please provide as much details as possible - some bugs are hard to investigate and reproduce.
Thank you for helping us fix our product.
- type: input
id: version
attributes:
label: Version
description: What version are you using?
placeholder: Version number
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behaviour
description: A precise description of what you expected to happen
placeholder: What should have happened?
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behaviour
description: A precise description of what actually happened
placeholder: What actually happened?
validations:
required: true

- type: textarea
id: bug-description
attributes:
label: Bug Description
description: A precise description of what the bug is
placeholder: Describe the bug.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Precise steps to reproduce the behaviour
placeholder: |
Step 1
Step 2
Step 3...
validations:
required: true

- type: textarea
id: code_sample
attributes:
label: Code Sample
description: If you believe it would help, please add a minimal code sample that reproduces the issue
placeholder: Your code goes here
validations:
required: false

- type: textarea
id: logs
attributes:
label: Error Logs
description: If you believe it would help, please add any error messages or logs
placeholder: Error messages go here.
validations:
required: false

- type: textarea
id: additional_info
attributes:
label: Additional Info
description: Add any other info about the problem here (screenshots, videos, related issues, etc.)
placeholder: Additional information that might help.
validations:
required: false
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/2-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Documentation Issue
description: Report an issue with documentation
title: "[Docs]: "
type: task
body:
- type: markdown
attributes:
value: |
Please read [this](https://engineering.hmn.md/projects/support/) before proceeding forward.
Please note that we don't offer detailed end-user support.
This template is just for documentation issues, not for questions.
If the opened issue doesn't have all of the needed information, or it's off-topic, we will close it.
Please provide as much details as possible about the documentation issue you've found.
Thank you for helping us improve our documentation.
- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What kind of documentation issue is this?
options:
- "Missing documentation"
- "Incorrect information"
- "Outdated information"
- "Unclear/confusing explanation"
- "Broken example/code"
- "Typo/grammar error"
- "Missing example"
- "Broken link"
- "Other"
validations:
required: true

- type: input
id: location
attributes:
label: Documentation Location
description: Where is this documentation located?
placeholder: "Document URL goes here"
validations:
required: true

- type: textarea
id: description
attributes:
label: Issue Description
description: Describe the documentation issue in detail
placeholder: "Documentation issue explanation goes here"
validations:
required: true

- type: textarea
id: current-content
attributes:
label: Current Content
description: If you believe it would help, please copy the current documentation content that needs to be fixed
render: markdown
placeholder: "Current documentation content."

- type: textarea
id: suggested-content
attributes:
label: Suggested Improvement
description: How do you think this should be documented instead?
render: markdown
placeholder: "Suggested documentation content."

- type: textarea
id: additional_info
attributes:
label: Additional Info
description: Add any other info that would help us improve the documentation
placeholder: |
- This confused me because...
- Screenshots would have been helpful because...
- Detailed output would have been valuable because...
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/3-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Feature Request
description: Submit a feature request
title: "[Feature]: "
type: feature
body:
- type: markdown
attributes:
value: |
Please read [this](https://engineering.hmn.md/projects/support/) before proceeding forward.
Please note that we don't offer detailed end-user support.
This template is just for feature requests, not for questions.
If the opened issue doesn't have all of the needed information, or it's off-topic, we will close it.
Please provide as much details as possible about the feature you need.
Thank you for helping us build a better product.
- type: textarea
id: context
attributes:
label: Context
description: Is this request related to a specific problem, workflow, or limitation?
placeholder: Describe the background or scenario that led to this request.
validations:
required: true

- type: textarea
id: current_behaviour
attributes:
label: Current Behaviour
description: A precise description of how things work now
placeholder: How is it working now?
validations:
required: true

- type: textarea
id: improved_behaviour
attributes:
label: Improved Behaviour
description: A precise description of how things should work
placeholder: How it should be working?
validations:
required: true

- type: textarea
id: impact
attributes:
label: Impact
description: An explanation why you believe this brings value and what's the impact on other users
placeholder: |
What's the value?
What's the impact?
validations:
required: true

- type: textarea
id: possible_solutions
attributes:
label: Possible Solutions
description: Do you already have ideas or examples of how this could be implemented?
placeholder: Share your thoughts, examples, or references.
validations:
required: false

- type: textarea
id: acceptance_criteria
attributes:
label: Acceptance Criteria
description: When would you say this feature is complete? List clear conditions or test cases.
placeholder: |
- [ ] User can do X
- [ ] Feature works under Y condition
- [ ] Documentation updated
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Loading