Skip to content

Commit f12ee88

Browse files
ArgmasterArgmaster
committed
Add language_server_bug_form.yml
1 parent ac989b5 commit f12ee88

File tree

2 files changed

+249
-0
lines changed

2 files changed

+249
-0
lines changed

‎.github/ISSUE_TEMPLATE/language_server_bug.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
name: Language Server Bug Report
3+
about: Report a bug in PyGerber's language server.
4+
title: "[Language Server]: <when-i-am-doing-something-then-something-fails>"
5+
labels: ["language-server", "bug", "waiting-for-checkboxes"]
6+
projects: ["argmaster/3"]
7+
assignees: "Argmaster"
8+
---
9+
10+
# Language Server Bug Report
11+
12+
## Mandatory checks
13+
14+
> Checks listed below are mandatory for opening a new issue.
15+
16+
> If haven't done any of the checks listed below, please do that, we will not look into
17+
> the issue until all of the checks in mandatory checks section are checked.
18+
19+
### Before opening this issue:
20+
21+
- [ ] I have reviewed the README for language server related guidelines and haven't
22+
found a solution there.
23+
- [ ] I have reviewed the language server documentation and haven't found a solution
24+
there.
25+
- [ ] I have reviewed the existing open issues and verified that this is not a
26+
duplicate.
27+
- [ ] I have reviewed the existing closed issues and verified that this was already
28+
resolved or marked as won't fix.
29+
- [ ] I have reviewed the existing pull requests and verified that this is not a already
30+
known issue.
31+
- [ ] I have reviewed the existing discussions and verified that this is not a already
32+
known issue.
33+
34+
> If you have found a issue / discussion / pull request describing similar but not quite
35+
> matching issue, You can still open new issue, we will review it and decide if we want
36+
> to merge them. If you can, please reference this issue here:
37+
38+
## To Reproduce
39+
40+
> Please provide a clear list of steps to reproduce the behavior.
41+
42+
> You can include code snippets or screenshots for individual steps to make it easier to
43+
> reproduce.
44+
45+
1. Go to '...'
46+
2. Click on '....'
47+
3. Scroll down to '....'
48+
4. See error
49+
50+
## Expected behavior
51+
52+
> A clear and concise description of what you expected to happen. If this issue is
53+
> related to image rendering, please post a screenshot from
54+
> [Reference Gerber Viewer](https://gerber-viewer.ucamco.com/) or CAD software used. If
55+
> the design is confidential, follow guidelines regarding confidential files available
56+
> in `Additional context` section below.
57+
58+
## Additional context
59+
60+
> If applicable, add screenshots, code examples, or any other resources that can speed
61+
> up process of reproducing and fixing the issue.
62+
63+
> If your issue was discovered with use of specific source file (e.g. in Gerber format),
64+
> please attach it to the issue. If file is confidential, please create minimal subset
65+
> of the file which can be shared in public and allows to reproduce the issue.
66+
67+
> If you are not able to create minimal reproduction for confidential source, you can
68+
> email me the confidential file at `[email protected]` with the issue title in
69+
> the subject. I will not share the file anywhere in public and will delete it after the
70+
> issue is resolved. We can discuss NDA agreements via email if needed.
71+
72+
> You still should create a public issue based on this template for the issue to be
73+
> investigated, please use `<confidential-file>`, `<confidential-image>`, etc. as a
74+
> placeholders for the confidential files.
75+
76+
## Environment:
77+
78+
**Please complete the following information:**
79+
80+
- Operating system: [e.g. `Ubuntu 24.04`]
81+
- Python version: [e.g. `3.9.0`]
82+
- PyGerber version: [e.g. `3.0.0`]
83+
- IDE: [e.g. `Visual Studio Code`]
84+
- IDE extension: [e.g. `argmaster.gerber-x3-x2-format-support`]
85+
86+
## Optional checks
87+
88+
> Agreements listed below are optional, but consider checking them if it is not harmful
89+
> for you to do so. You can greatly improve PyGerber doing so.
90+
91+
- [ ] I want to contribute example source files attached to this issue in the test suite
92+
of PyGerber for regression testing purposes.
93+
- [ ] I want to include separate LICENSE file for resource files attached as a result of
94+
an agreement described in first checkbox in this section.
95+
- [ ] I want to include separate README file for resource files attached as a result of
96+
an agreement described in first checkbox in this section.

‎.github/ISSUE_TEMPLATE/language_server_bug_form.yml

+153
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
name: Language Server Bug Report Form
2+
description: Report a bug in PyGerber's language server.
3+
title: "[Language Server]: <when-i-am-doing-something-then-something-fails>"
4+
labels: ["language-server", "bug", "waiting-for-checkboxes"]
5+
projects: ["argmaster/3"]
6+
assignees:
7+
- Argmaster
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
# Language Server Bug Report
13+
14+
Thank you for reporting a bug in PyGerber's language server. Please fill out the
15+
following form to help us understand the issue better.
16+
17+
- type: checkboxes
18+
id: pre_checks
19+
attributes:
20+
label: Mandatory checks
21+
description: |
22+
Before opening this issue I have done the following:
23+
options:
24+
- label: I have reviewed the README for language server related guidelines and haven't found a solution there.
25+
required: true
26+
- label: I have reviewed the language server documentation and haven't found a solution there.
27+
required: true
28+
- label: I have reviewed the existing open issues and verified that this is not a duplicate.
29+
required: true
30+
- label: I have reviewed the existing closed issues and verified that this was already resolved or marked as won't fix.
31+
required: true
32+
- label: I have reviewed the existing pull requests and verified that this is not a already known issue.
33+
required: true
34+
- label: I have reviewed the existing discussions and verified that this is not a already known issue.
35+
required: true
36+
37+
- type: markdown
38+
attributes:
39+
value: >
40+
If you have found a issue / discussion / pull request describing similar but not quite
41+
matching issue, You can still open new issue, we will review it and decide if we want to
42+
merge them.
43+
44+
- type: textarea
45+
attributes:
46+
label: Steps To Reproduce
47+
description: >
48+
Steps to reproduce the behavior.
49+
50+
You can include code snippets or screenshots for individual steps to make it easier to
51+
reproduce the issue.
52+
placeholder: |
53+
1. Go to '...'
54+
2. Click on '....'
55+
3. Scroll down to '....'
56+
4. See error
57+
58+
- type: textarea
59+
attributes:
60+
label: Expected behavior
61+
description: >
62+
A clear and concise description of what you expected to happen. If this issue is related
63+
to image rendering, please post a screenshot from
64+
[Reference Gerber Viewer](https://gerber-viewer.ucamco.com/) or CAD software used. If
65+
the design is confidential, follow guidelines regarding confidential files available in
66+
`Additional context` section below.
67+
placeholder: |
68+
The image should look like this...
69+
Description of the element should be more like this...
70+
In the specification it is mentioned that...
71+
72+
- type: textarea
73+
attributes:
74+
label: Additional context
75+
description: >
76+
If applicable, add screenshots, code examples, or any other resources that can speed up
77+
process of reproducing and fixing the issue.
78+
79+
80+
If your issue was discovered with use of specific source file (e.g. in Gerber format),
81+
please attach it to the issue. If file is confidential, please create minimal subset of
82+
the file which can be shared in public and allows to reproduce the issue.
83+
84+
85+
If you are not able to create minimal reproduction for confidential source, you can
86+
email me the confidential file at `[email protected]` with the issue title in
87+
the subject. I will not share the file anywhere in public and will delete it after the
88+
issue is resolved. We can discuss NDA agreements via email if needed.
89+
90+
91+
You still should create a public issue based on this template for the issue to be
92+
investigated, please use `<confidential-file>`, `<confidential-image>`, etc. as a
93+
placeholders for the confidential files.
94+
95+
placeholder: |
96+
...
97+
98+
- type: markdown
99+
attributes:
100+
value: >
101+
### Environment
102+
103+
- type: input
104+
id: os_name
105+
attributes:
106+
label: Operating system
107+
placeholder: Windows 10, Ubuntu 20.04, macOS 11.0, etc.
108+
109+
- type: input
110+
id: python_version
111+
attributes:
112+
label: Python version
113+
placeholder: 3.8.5, 3.9.0, etc.
114+
115+
- type: input
116+
id: pygerber_version
117+
attributes:
118+
label: PyGerber version
119+
placeholder: 0.1.0, 0.2.0, etc.
120+
121+
- type: input
122+
id: ide_name
123+
attributes:
124+
label: Integrated Development Environment (IDE)
125+
placeholder: Visual Studio Code, etc.
126+
127+
- type: input
128+
id: ide_version
129+
attributes:
130+
label: IDE version
131+
placeholder: 1.90.0, 1.93.1, etc.
132+
133+
- type: checkboxes
134+
id: post_checks
135+
attributes:
136+
label: Optional agreements
137+
description: >
138+
Agreements listed below are optional, but consider checking them if it is not
139+
harmful for you to do so. You can greatly improve PyGerber doing so.
140+
options:
141+
- label: >
142+
I want to include example source files attached to this issue in the
143+
test suite of PyGerber for regression testing purposes. I understand that
144+
the files will be publicly available in the repository.
145+
required: false
146+
- label: >
147+
I want to include separate LICENSE file for resource files attached as a
148+
result of an agreement described in first checkbox in this section.
149+
required: false
150+
- label: >
151+
I want to include separate README file for resource files attached as a
152+
result of an agreement described in first checkbox in this section.
153+
required: false

0 commit comments

Comments
 (0)