mirror of
https://github.com/i3/i3.git
synced 2025-12-01 12:06:20 +00:00
Use new GitHub issue templates (#5900)
Biggest benefit is that the users are presented with a set of editable fields instead of having to edit markdown directly in a text box, which is less friendly. Links to userguide and IPC docs are clickable in the description. See https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
This commit is contained in:
Orestis Floros
GitHub
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,72 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
---
|
||||
|
||||
<!--
|
||||
PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
|
||||
-->
|
||||
|
||||
## I'm submitting a…
|
||||
<!-- Please check one of the following options with "x" -->
|
||||
<pre>
|
||||
[x] Bug
|
||||
[ ] Feature Request
|
||||
[ ] Documentation Request
|
||||
[ ] Other (Please describe in detail)
|
||||
</pre>
|
||||
|
||||
## Current Behavior
|
||||
<!--
|
||||
Describe the current behavior,
|
||||
e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
|
||||
-->
|
||||
|
||||
## Expected Behavior
|
||||
<!--
|
||||
Describe the desired behavior you expect after mitigation of the issue,
|
||||
e.g., »The window left next to the current window should be focused.«
|
||||
-->
|
||||
|
||||
## Reproduction Instructions
|
||||
<!--
|
||||
Please provide detailed instructions on how the bug can be reproduced.
|
||||
E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
|
||||
-->
|
||||
|
||||
## Environment
|
||||
<!--
|
||||
Please include your exact i3 version.
|
||||
Note that we only support the latest major release and the current development version. If you are using an older version of i3, please first update to the current release version and reproduce the issue there.
|
||||
-->
|
||||
Output of `i3 --moreversion 2>&-`:
|
||||
<pre>
|
||||
i3 version:
|
||||
</pre>
|
||||
|
||||
<!--
|
||||
Please include your (complete) i3 config with which the issue occurs. You can either paste the file directly or provide a link to a service such as pastebin.
|
||||
|
||||
If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
|
||||
-->
|
||||
<details><summary>Config file</summary><pre>
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<!--
|
||||
Providing a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
|
||||
https://i3wm.org/docs/debugging.html
|
||||
|
||||
Providing the logfile is optional.
|
||||
-->
|
||||
<pre>
|
||||
Logfile URL:
|
||||
</pre>
|
||||
|
||||
<!--
|
||||
Please also answer the questions below to help us process your issue faster. If you have any other information to share, please add it here as well.
|
||||
-->
|
||||
<pre>
|
||||
- Linux Distribution & Version:
|
||||
- Are you using a compositor (e.g., xcompmgr or compton):
|
||||
</pre>
|
||||
107
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Executable file
107
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Executable file
@ -0,0 +1,107 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help us improve.
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Welcome
|
||||
options:
|
||||
- label: Yes, I'm using the latest major release or the current development version. These are the only supported versions.
|
||||
required: true
|
||||
- label: Yes, I've searched similar issues and discussions on GitHub and didn't find any.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: current
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
placeholder: |-
|
||||
Describe the current behavior,
|
||||
e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
placeholder: |-
|
||||
Describe the desired behavior you expect after mitigation of the issue,
|
||||
e.g., »The window left next to the current window should be focused.«
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Reproduction Instructions
|
||||
placeholder: |-
|
||||
Please provide detailed instructions on how the bug can be reproduced.
|
||||
E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: version
|
||||
attributes:
|
||||
label: i3 version
|
||||
description: |-
|
||||
Paste the output of
|
||||
```
|
||||
i3 --moreversion 2>&-
|
||||
```
|
||||
render: text
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: config
|
||||
attributes:
|
||||
label: Config file
|
||||
description: |-
|
||||
Please include your (complete) i3 config with which the issue occurs.
|
||||
|
||||
If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
|
||||
render: text
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: distro
|
||||
attributes:
|
||||
label: Linux distribution & Version
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: compositor
|
||||
attributes:
|
||||
label: Are you using a compositor?
|
||||
description: |-
|
||||
Try running
|
||||
```shell
|
||||
pidof picom
|
||||
pidof compton
|
||||
```
|
||||
If any IDs show up, you are running a compositor
|
||||
options:
|
||||
- I don't know
|
||||
- I am sure I don't run any compositor
|
||||
- picom
|
||||
- compton
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: verbose-output
|
||||
attributes:
|
||||
label: Logfile
|
||||
description: |-
|
||||
Providing the URL to a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
|
||||
https://i3wm.org/docs/debugging.html
|
||||
|
||||
Providing the logfile is optional.
|
||||
validations:
|
||||
required: false
|
||||
3
.github/ISSUE_TEMPLATE/config.yml
vendored
3
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,4 +1,7 @@
|
||||
contact_links:
|
||||
- name: Userguide
|
||||
url: https://i3wm.org/docs/userguide.html
|
||||
about: i3 User’s Guide
|
||||
- name: Ask a question or request support for using i3
|
||||
url: https://github.com/i3/i3/discussions/new
|
||||
about: Ask a question or request support for using i3
|
||||
|
||||
56
.github/ISSUE_TEMPLATE/feature_request.md
vendored
56
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,56 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
---
|
||||
|
||||
<!--
|
||||
PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
|
||||
-->
|
||||
|
||||
## I'm submitting a…
|
||||
<!-- Check one of the following options with "x" -->
|
||||
<pre>
|
||||
[ ] Bug
|
||||
[x] Feature Request
|
||||
[ ] Documentation Request
|
||||
[ ] Other (Please describe in detail)
|
||||
</pre>
|
||||
|
||||
## Current Behavior
|
||||
<!--
|
||||
Describe the current behavior,
|
||||
e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
|
||||
-->
|
||||
|
||||
## Desired Behavior
|
||||
<!--
|
||||
Describe the desired behavior you expect after mitigation of the issue,
|
||||
e.g., »The window left next to the current window should be focused.«
|
||||
-->
|
||||
|
||||
## Impact
|
||||
<!--
|
||||
Please note that at this point we focus on maintaining i3 and fixing bugs, and will rarely consider features which require further configuration or significant complexity.
|
||||
In such cases you should consider and present specific benefits derived from adding this feature such that it can be weighed against the cost of additional complexity and maintenance.
|
||||
-->
|
||||
<pre>
|
||||
[ ] This feature requires new configuration and/or commands
|
||||
</pre>
|
||||
|
||||
## Environment
|
||||
<!--
|
||||
Please include your exact i3 version.
|
||||
Note that we only support the latest major release and the current development version. If you are using an older version of i3, please first update to the current release version and reproduce the issue there.
|
||||
-->
|
||||
Output of `i3 --moreversion 2>&-`:
|
||||
<pre>
|
||||
i3 version:
|
||||
</pre>
|
||||
|
||||
<!--
|
||||
Please also answer the questions below to help us process your issue faster. If you have any other information to share, please add it here as well.
|
||||
-->
|
||||
<pre>
|
||||
- Linux Distribution & Version:
|
||||
- Are you using a compositor (e.g., xcompmgr or compton):
|
||||
</pre>
|
||||
57
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Executable file
57
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Executable file
@ -0,0 +1,57 @@
|
||||
name: Feature request
|
||||
description: Suggest an idea for this project
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Welcome
|
||||
options:
|
||||
- label: Yes, I've searched similar issues and discussions on GitHub and didn't find any.
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
description: |-
|
||||
Please note that at this point we focus on maintaining i3 and fixing bugs, and will rarely consider features which require further configuration or significant complexity.
|
||||
In such cases you should consider and present specific benefits derived from adding this feature such that it can be weighed against the cost of additional complexity and maintenance.
|
||||
Keep in mind that i3 provides a powerful way to interact with it through its IPC interface: https://i3wm.org/docs/ipc.html.
|
||||
options:
|
||||
- label: This feature requires new configuration and/or commands
|
||||
required: false
|
||||
|
||||
|
||||
- type: textarea
|
||||
id: current
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
placeholder: |-
|
||||
Describe the current behavior,
|
||||
e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: desired
|
||||
attributes:
|
||||
label: Desired Behavior
|
||||
placeholder: |-
|
||||
Describe the desired behavior you expect after mitigation of the issue,
|
||||
e.g., »The window left next to the current window should be focused.«
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: version
|
||||
attributes:
|
||||
label: i3 version
|
||||
description: |-
|
||||
Paste the output of
|
||||
```
|
||||
i3 --moreversion 2>&-
|
||||
```
|
||||
render: text
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user