Skip to content
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

chore: Add a template for issues #35

Merged
merged 12 commits into from
Feb 19, 2025
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Bug report
description: Report a bug to help us improve RustOwl
labels: bug
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug!

Before submitting, please search existing issues to avoid duplicates. If a similar issue exists, comment there instead of opening a new one.

To help us resolve the issue efficiently, please provide the necessary details below.

- type: textarea
id: bug-description
attributes:
label: Bug Description
description: Describe the issue you encountered.
placeholder: Provide a clear and concise description of the problem, including what you expected to happen and what actually occurred.
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Provide details about your setup.
placeholder: |
- OS: [e.g., Windows 11, macOS Sequoia 15.2, Ubuntu 24.04]
- rustc Version: [e.g., 1.84.1 (e71f9a9a9 2025-01-27)]
- rustup Version: [e.g., 1.27.1 (54dd3d00f 2024-04-24)]
- RustOwl Version: [e.g., v0.1.1]
- Editor: [e.g., VSCode 1.97, Neovim, Emacs]
validations:
required: true
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: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature request
description: Suggest an idea for RustOwl
labels: enhancement
body:
- type: textarea
attributes:
label: What is the problem you're trying to solve
description: |
A clear and concise description of what the problem is.
validations:
required: true

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

- type: textarea
attributes:
label: Additional context
description: |
Add any other context about the feature request here.