Skip to content
Open
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
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

136 changes: 136 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
name: Bug Report
description: File a bug report to help us improve NixOS-WSL
title: "[Bug]: "
labels: ["bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible.

- type: textarea
id: bug-description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe what happened and what you expected to happen instead.
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to Reproduce
description: Tell us how to reproduce this behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: nixos-wsl-version
attributes:
label: NixOS-WSL Version Information
description: Please run the nixos-wsl-version command and paste the complete output. If the command doesn't exist, see fallback instructions below.
placeholder: |
Run this command in your NixOS-WSL terminal:
nixos-wsl-version

Expected output format:
NixOS-WSL 24.05.123456 abcdef123456

If the command doesn't exist or fails, please provide:
- Contents of /etc/os-release
- Output of: cat /etc/nixos-wsl-release (if file exists)
- Your installation method and source
render: shell
validations:
required: true

- type: textarea
id: system-info
attributes:
label: System Information
description: Please provide information about your system.
placeholder: |
- WSL Version: (output of `wsl --version`)
- Windows Version: (e.g., Windows 11 22H2)
- Architecture: (x86_64, aarch64, etc.)
render: shell
validations:
required: true

- type: textarea
id: configuration
attributes:
label: Relevant Configuration
description: Please share relevant parts of your NixOS configuration.
placeholder: |
Share relevant configuration that might be related to your issue:

Common WSL-specific options to include:
```nix
wsl = {
enable = true;
defaultUser = "your-username";
useWindowsDriver = true; # or false
interop.enabled = true; # or false
# ... other wsl.* options you've configured
};
```

Also include from configuration.nix/flake.nix:
- Any wsl.* settings you've customized
- Systemd/networking configuration (if networking issues)
- Docker/virtualization settings (if container issues)
- Custom kernel or boot settings (if boot issues)
- User/group configurations (if permission issues)

Please only include sections relevant to your issue.
render: nix

- type: textarea
id: logs
attributes:
label: Logs and Error Messages
description: If applicable, add relevant logs or error messages.
placeholder: |
Include any relevant logs, error messages, or command output.

You can often find logs in:
- `journalctl` output
- `dmesg` output
- WSL logs
render: shell

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here.
placeholder: Screenshots, workarounds you've tried, or any other information that might be helpful.

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following before submitting.
options:
- label: I have searched existing issues to make sure this is not a duplicate.
required: true
- label: I have included the output of `nixos-wsl-version`.
required: true
- label: I have provided clear steps to reproduce the issue.
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Discussions
url: https://github.com/nix-community/NixOS-WSL/discussions
about: Ask questions and discuss ideas with the community
- name: 🗨️ Matrix Chat
url: https://matrix.to/#/#wsl:nixos.org
about: Join our Matrix chat room for real-time discussions
- name: 📖 Documentation
url: https://nix-community.github.io/NixOS-WSL/
about: Check the documentation for guides and troubleshooting
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Documentation Issue
description: Report an issue with the documentation
title: "[Docs]: "
labels: ["documentation"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve our documentation! Please describe the issue you found.

- type: input
id: docs-url
attributes:
label: Documentation URL
description: What page or section of the documentation has an issue?
placeholder: "https://nix-community.github.io/NixOS-WSL/..."
validations:
required: true

- type: dropdown
id: issue-type
attributes:
label: Type of Documentation Issue
description: What kind of issue is this?
options:
- Information is incorrect or outdated
- Information is missing or incomplete
- Instructions don't work or are unclear
- Typo or formatting issue
- Other
validations:
required: true

- type: textarea
id: issue-description
attributes:
label: Description of the Issue
description: Describe what's wrong with the documentation.
placeholder: |
- What did you expect to find?
- What did you actually find?
- What was confusing or incorrect?
validations:
required: true

- type: textarea
id: suggested-improvement
attributes:
label: Suggested Improvement
description: How do you think this could be improved?
placeholder: |
- What should be changed?
- What additional information should be added?
- How could the instructions be clearer?

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other context about the documentation issue.
placeholder: Screenshots, examples, or other relevant information.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Feature Request
description: Suggest an idea for NixOS-WSL
title: "[Feature]: "
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please fill out the sections below to help us understand your 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: true

- 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: Describe your ideal solution...
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: What other approaches have you thought about?

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe your specific use case and how this feature would help.
placeholder: |
- What would you use this feature for?
- How would it improve your workflow?
- Are there existing workarounds you're using?

- type: textarea
id: nixos-wsl-version
attributes:
label: NixOS-WSL Version Information
description: Please run the nixos-wsl-version command and paste the output here (helps us understand your current setup). If the command doesn't exist, see fallback instructions below.
placeholder: |
Run this command in your NixOS-WSL terminal:
nixos-wsl-version

Expected output format:
NixOS-WSL 24.05.123456 abcdef123456

If the command doesn't exist or fails, please provide:
- Contents of /etc/os-release
- Output of: cat /etc/nixos-wsl-release (if file exists)
- Your installation method and source
render: shell

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
placeholder: Any additional information, mockups, or examples that might be helpful.

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following before submitting.
options:
- label: I have searched existing issues and discussions to make sure this hasn't been requested before.
required: true
- label: This feature request is specific to NixOS-WSL (not a general NixOS or WSL feature).
required: true
Loading