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

Add issue templates #16213

Merged
merged 6 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Bug report
description: Report an error or unexpected behavior
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report an issue! We're glad to have you involved with Ruff.

- type: textarea
attributes:
label: Summary
description: |
A clear and concise description of the bug, including a minimal reproducible example.

Be sure to include the command you invoked (e.g., `ruff /path/to/file.py --fix`), ideally including the `--isolated` flag or
the current Ruff settings (e.g., relevant sections from your `pyproject.toml`).

validations:
required: true

- type: input
attributes:
label: Platform
description: What operating system and architecture are you using? (see `uname -orsm`)
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
validations:
required: true

- type: input
attributes:
label: Version
description: What version of ruff are you using? (see `ruff version`)
placeholder: e.g., ruff 0.5.0 (244b923f6 2024-06-27)
validations:
required: true

- type: input
attributes:
label: Python version
description: What version of Python are you using? (see `uv run python --version`)
placeholder: e.g., Python 3.12.6
validations:
required: false
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Feature request
description: Suggest a new feature or improvement
labels: ["enhancement"]
body:
- type: textarea
attributes:
label: Summary
description: |
A clear and concise description of what new feature or behavior you would like to see. If applicable, please describe the current behavior as well.
validations:
required: true

- type: textarea
attributes:
label: Example
description: Provide an example of how the user experience would change or how the new feature would be used.
validations:
required: false
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/3_question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Question
description: Ask a question about uv
labels: ["question"]
body:
- type: textarea
attributes:
label: Question
description: Describe your question in detail.
validations:
required: true

- type: input
attributes:
label: Platform
description: What operating system and architecture are you using? (see `uname -orsm`)
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
validations:
required: false

- type: input
attributes:
label: Version
description: What version of ruff are you using? (see `ruff version`)
placeholder: e.g., ruff 0.5.0 (244b923f6 2024-06-27)
validations:
required: false
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# This file cannot use the extension `.yaml`.
blank_issues_enabled: false
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://docs.astral.sh/ruff
about: Please consult the documentation before creating an issue.
- name: Community
url: https://discord.com/invite/astral-sh
about: Join our Discord community to ask questions and collaborate.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/issue.yaml

This file was deleted.

Loading