Skip to content

Commit c46192e

Browse files
chore: GitHub issue and PR template
1 parent 06ede90 commit c46192e

4 files changed

Lines changed: 172 additions & 0 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Bug report
2+
description: Report a reproducible problem with the plugin
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for opening an issue! 🙌
10+
11+
Please provide as much detail as possible so we can reproduce and investigate the problem.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Bug description
17+
description: What happened?
18+
placeholder: Describe the problem clearly.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: steps
24+
attributes:
25+
label: Steps to reproduce
26+
description: Please provide a detailed, reproducible description.
27+
placeholder: |
28+
1. Open ...
29+
2. Click ...
30+
3. See error ...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected behavior
38+
placeholder: What did you expect to happen?
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual behavior
46+
placeholder: What actually happened?
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: stacktrace
52+
attributes:
53+
label: Stack trace or logs
54+
description: Paste any stack trace or relevant logs here, if available.
55+
render: text
56+
57+
- type: textarea
58+
id: screenshots
59+
attributes:
60+
label: Screenshots or screen recordings
61+
description: Add screenshots or recordings if they help explain the issue.
62+
63+
- type: input
64+
id: ide-version
65+
attributes:
66+
label: JetBrains IDE and version
67+
placeholder: IntelliJ IDEA 2024.3, WebStorm 2024.3, PyCharm 2024.3, etc.
68+
69+
- type: input
70+
id: plugin-version
71+
attributes:
72+
label: Plugin version
73+
placeholder: 1.2.3
74+
75+
- type: textarea
76+
id: additional-context
77+
attributes:
78+
label: Additional context
79+
placeholder: Anything else that may help?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions or support
4+
url: https://github.com/marcelkliemannel/intellij-developer-tools-plugin/discussions
5+
about: Please use Discussions for questions, support requests, and general ideas.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature request
2+
description: Suggest an improvement for the plugin
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for opening an issue! 🙌
10+
11+
Please note: this is a general IntelliJ plugin intended to work across all JetBrains IDEs.
12+
13+
Features that are specific to one programming language, framework, or technology stack are usually out of scope for this plugin.
14+
15+
- type: textarea
16+
id: problem
17+
attributes:
18+
label: Problem description
19+
description: What problem are you trying to solve?
20+
placeholder: Describe the use case or pain point.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Proposed solution
28+
description: What would you like to happen?
29+
placeholder: Describe the feature you would like to see.
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: scope-confirmation
35+
attributes:
36+
label: Scope confirmation
37+
description: Is this feature general enough to work across JetBrains IDEs?
38+
options:
39+
- Yes, this is a general feature for JetBrains IDEs
40+
- No, this is specific to a language, framework, or technology stack
41+
- Not sure
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: alternatives
47+
attributes:
48+
label: Alternatives considered
49+
placeholder: Describe any alternatives or workarounds you have considered.
50+
51+
- type: textarea
52+
id: additional-context
53+
attributes:
54+
label: Additional context
55+
placeholder: Add screenshots, examples, or other context here.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## 🙌 Thanks for your contribution
2+
3+
We really appreciate your effort in improving this plugin.
4+
5+
---
6+
7+
## ⚠️ Before submitting a PR
8+
9+
Please note:
10+
11+
- It is **required to open an issue first** before submitting a pull request.
12+
- The issue should clearly describe the problem and **propose a solution or approach**.
13+
- This ensures that changes are aligned with the overall direction of the project.
14+
15+
👉 **Unsolicited pull requests (without prior discussion) are usually not appropriate and may be closed.**
16+
17+
---
18+
19+
## 🔗 Related Issue
20+
21+
Please link the issue this PR is based on:
22+
23+
Fixes #...
24+
25+
---
26+
27+
## ✨ What does this PR do?
28+
29+
Describe your changes clearly:
30+
- What problem does it solve?
31+
- What was your approach?
32+
33+
---

0 commit comments

Comments
 (0)