Skip to content

Commit 8bbfdbf

Browse files
simschlasimschla
committed
chore: try github issue-templates
1 parent 44e6478 commit 8bbfdbf

File tree

3 files changed

+187
-0
lines changed

3 files changed

+187
-0
lines changed

‎.github/ISSUE_TEMPLATE/01-bug.yml‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
name: Report a Bug
3+
description: File a bug report for spotless-cli
4+
title: "[BUG]: "
5+
labels: ["bug-unconfirmed"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for reporting a bug! Please take the time to fill out the following form so that we can
12+
understand and reproduce the issue.
13+
14+
Before submitting:
15+
- Have you checked for **existing issues** in both [`spotless-cli`](https://github.com/diffplug/spotless-cli/issues) and [`spotless`](https://github.com/diffplug/spotless/issues)?
16+
- Is this issue about formatting behavior that might belong to the [`spotless`](https://github.com/diffplug/spotless) library instead?
17+
18+
- type: checkboxes
19+
id: pre_submission_checklist
20+
attributes:
21+
label: Pre-submission checks
22+
description: Please confirm the following before submitting.
23+
options:
24+
- label: I have searched for [existing issues in spotless-cli](https://github.com/diffplug/spotless-cli/issues).
25+
required: true
26+
- label: I have searched for [existing issues in spotless](https://github.com/diffplug/spotless/issues).
27+
required: true
28+
- label: This issue is specific to `spotless-cli`, and not just the formatting logic in `spotless-lib`.
29+
required: true
30+
31+
- type: textarea
32+
id: cli-version
33+
attributes:
34+
label: spotless-cli version
35+
description: Run `spotless --version` to get the version.
36+
placeholder: |
37+
e.g.
38+
--------------------------------------------------
39+
🧼 Spotless CLI 0.1.0
40+
--------------------------------------------------
41+
42+
spotless-lib: 3.1.0
43+
spotless-lib-extra: 3.1.0
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: os
49+
attributes:
50+
label: Operating system and architecture
51+
options:
52+
- macOS (Intel)
53+
- macOS (Apple Silicon / ARM)
54+
- Linux (Intel)
55+
- Linux (ARM)
56+
- Windows (x64)
57+
- I don't know (Please specify in the comment section)
58+
validations:
59+
required: true
60+
61+
# # # #
62+
- type: textarea
63+
id: command
64+
attributes:
65+
label: CLI command used
66+
description: The exact `spotless` command you ran.
67+
placeholder: |
68+
e.g. spotless --target '**/src/**/*.java' \
69+
google-java-format \
70+
license-header --header='/* (c) DiffPlug $YEAR */'
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: problem
76+
attributes:
77+
label: Description of the problem
78+
description: What did you expect to happen, and what actually happened?
79+
placeholder: Describe the unexpected behavior in detail.
80+
validations:
81+
required: true
82+
83+
- type: textarea
84+
id: logs
85+
attributes:
86+
label: Logs from the command line
87+
description: Please re-run your command with `-vvvvv` and paste the output here.
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
id: reproducibility
93+
attributes:
94+
label: Steps to reproduce
95+
description: How can we reproduce the issue? Include the minimum files and configuration needed.
96+
placeholder: |
97+
1. Create a file with the following content...
98+
2. Use this `.spotless.yaml` config...
99+
3. Run `spotless apply` and observe...
100+
validations:
101+
required: true
102+
103+
- type: textarea
104+
id: additional
105+
attributes:
106+
label: Additional context
107+
description: Include any error logs, stack traces, screenshots, or references to related issues.
108+
placeholder: |
109+
- stack trace here
110+
- related issue: #123
111+
- logs from console...
112+
validations:
113+
required: false

‎.github/ISSUE_TEMPLATE/02-feature-request.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Feature request
2+
description: Suggest a new feature or enhancement for spotless-cli
3+
title: "[Feature Request]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for suggesting a feature!
12+
13+
Please make sure your idea aligns with the goals of `spotless-cli`, which is a thin CLI layer around `spotless-lib`.
14+
15+
- type: textarea
16+
id: cli-version
17+
attributes:
18+
label: spotless-cli version (if relevant)
19+
description: If your request is based on a current limitation or behavior.
20+
placeholder: |
21+
e.g.
22+
--------------------------------------------------
23+
🧼 Spotless CLI 0.1.0
24+
--------------------------------------------------
25+
26+
spotless-lib: 3.1.0
27+
spotless-lib-extra: 3.1.0
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: feature-description
33+
attributes:
34+
label: Describe the feature
35+
description: What functionality would you like to see added?
36+
placeholder: |
37+
I would like to see support for...
38+
It would help because...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: motivation
44+
attributes:
45+
label: Motivation and use case
46+
description: Why is this feature important to you? What problem does it solve?
47+
placeholder: This feature would be useful for projects that...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: alternatives
53+
attributes:
54+
label: Alternatives considered
55+
description: Have you considered any workarounds or other tools?
56+
placeholder: Currently, I'm working around it by...
57+
validations:
58+
required: false
59+
60+
- type: dropdown
61+
id: scope
62+
attributes:
63+
label: Feature scope
64+
description: Where do you think this feature belongs?
65+
options:
66+
- label: This should be implemented in `spotless-cli`.
67+
- label: This may belong in `spotless-lib` instead.
68+
- label: Not sure.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Spotless Core Library Issues
5+
url: https://github.com/diffplug/spotless/issues
6+
about: Report an issue with the Spotless Core Library (if you suspect the bug to be inside the formatter itself).

0 commit comments

Comments
 (0)