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
121 changes: 121 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
name: Bug Report
description: File a bug report to help us improve
title: "[Bug]: "
labels: ["bug", "triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! 🐛

Please search existing issues before creating a new one to avoid duplicates.

- type: input
id: mitosis-version
attributes:
label: Mitosis Chain Version
description: What version of Mitosis Chain are you running?
placeholder: v1.0.0 or commit hash
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Environment
description: What environment are you running on?
options:
- Localnet
- Devnet
- Testnet
- Mainnet
- Custom
validations:
required: true

- type: input
id: os
attributes:
label: Operating System
description: What operating system are you using?
placeholder: Ubuntu 22.04, macOS 13.5, Windows 11, etc.
validations:
required: true

- type: input
id: go-version
attributes:
label: Go Version
description: What version of Go are you using?
placeholder: go version go1.21.5 linux/amd64
validations:
required: false

- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
placeholder: Describe the bug...
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: Describe what you expected to happen...
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide detailed steps to reproduce the issue.
placeholder: |
1. Run command `...`
2. Set configuration `...`
3. Observe error `...`
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: Please copy and paste any relevant log output.
render: shell
placeholder: Paste your logs here...
validations:
required: false

- type: textarea
id: config
attributes:
label: Configuration
description: Please provide relevant configuration files or settings.
render: yaml
placeholder: Paste your configuration here...
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here.
placeholder: Any additional information that might be helpful...
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
102 changes: 102 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
name: Documentation
description: Report missing, unclear, or incorrect documentation
title: "[Docs]: "
labels: ["documentation", "good first issue"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve our documentation! 📚

Clear documentation is essential for a great developer experience.

- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What type of documentation needs improvement?
options:
- README
- API Documentation
- Setup Guide
- CLI Documentation
- Code Comments
- Tutorial
- FAQ
- Other
validations:
required: true

- type: input
id: page-url
attributes:
label: Documentation Page/File
description: Link to the documentation page or file path that needs improvement
placeholder: https://docs.mitosis.org/... or path/to/file.md
validations:
required: false

- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What kind of documentation issue is this?
options:
- Missing documentation
- Incorrect information
- Unclear instructions
- Outdated content
- Typo/Grammar
- Broken links
- Missing examples
- Poor organization
validations:
required: true

- type: textarea
id: current-content
attributes:
label: Current Content
description: What does the current documentation say? (copy/paste relevant sections)
render: markdown
placeholder: Paste current documentation content here...
validations:
required: false

- type: textarea
id: suggested-improvement
attributes:
label: Suggested Improvement
description: How should the documentation be improved?
placeholder: The documentation should explain...
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional Context
description: |
Why is this improvement needed? What confusion does the current documentation cause?
placeholder: This would help developers who...
validations:
required: false

- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Would you like to contribute to fixing this documentation issue?
options:
- label: I'd like to work on this documentation improvement
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement", "triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature! 🚀

Please search existing issues and discussions before creating a new feature request.

- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when...
validations:
required: false

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: I would like...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: I've also considered...
validations:
required: false

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What type of feature is this?
options:
- CLI Enhancement
- Consensus Layer
- EVM Integration
- Performance Improvement
- Developer Experience
- Documentation
- Testing
- Infrastructure
- Security
- Other
validations:
required: true

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Nice to have
- Important
- Critical
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: Use Cases
description: Describe specific use cases where this feature would be beneficial.
placeholder: |
- As a validator operator, I want to...
- As a developer, I need to...
- As a user, I would like to...
validations:
required: true

- type: textarea
id: implementation
attributes:
label: Implementation Ideas
description: If you have ideas about how this could be implemented, please share them.
placeholder: This could be implemented by...
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples about the feature request here.
placeholder: Any additional information...
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
Loading
Loading