Skip to content

Commit eb0a9a0

Browse files
Add issue templates.
1 parent 6243be9 commit eb0a9a0

File tree

4 files changed

+174
-5
lines changed

4 files changed

+174
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: Bug report
2+
title: "[Bug] "
3+
description: Problems and issues with code of DSS
4+
labels: [bug, triage]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting the problem!
10+
Please make sure what you are reporting is a bug with reproducible steps. To ask questions
11+
or share ideas, pleae post on our [Discussion page](https://github.com/WeBankFinTech/DataSphereStudio/discussions) instead.
12+
13+
- type: checkboxes
14+
attributes:
15+
label: Search before asking
16+
description: >
17+
Please make sure to search in the [issues](https://github.com/WeBankFinTech/DataSphereStudio/issues) first to see
18+
whether the same issue was reported already.
19+
options:
20+
- label: >
21+
I searched the [issues](https://github.com/WeBankFinTech/DataSphereStudio/issues) and found no similar
22+
issues.
23+
required: true
24+
25+
- type: dropdown
26+
attributes:
27+
label: DSS Component
28+
description: |
29+
What component are you using? DSS has many modules, please make sure to choose the module that
30+
you found the bug.
31+
multiple: true
32+
options:
33+
- "dss-commons"
34+
- "dss-appconn"
35+
- "dss-framework"
36+
- "dss-orchestrator"
37+
- "dss-standard"
38+
- "dss-plugins"
39+
- "dss-apps/dss-apiservice"
40+
- "dss-web/dss-scriptis"
41+
- "dss-web/dss-workflow"
42+
- "dss-web/workspace"
43+
- "dss-web/dss-apiservice"
44+
- "dss-web/framework"
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
attributes:
50+
label: What happened + What you expected to happen
51+
description: Describe 1. the bug 2. expected behavior 3. useful information (e.g., logs)
52+
placeholder: >
53+
Please provide the context in which the problem occurred and explain what happened. Further,
54+
To Reproduce Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '.... 4. See error
55+
please also explain why you think the behaviour is erroneous. It is extremely helpful if you can
56+
copy and paste the fragment of logs showing the exact error messages or wrong behaviour here.
57+
58+
**NOTE**: Expected behavior A clear and concise description of what you expected to happen.Screenshots If applicable, add screenshots to help explain your problem.
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Relevent platform
65+
description: The platform where you occurred this issue
66+
placeholder: >
67+
Please specify Desktop or Smartphone, Version / Dependencies / OS / Browser
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: Reproduction script
74+
description: >
75+
Please provide a reproducible script. Providing a narrow reproduction (minimal / no external dependencies) will
76+
help us triage and address issues in the timely manner!
77+
placeholder: >
78+
Please provide a short code snippet (less than 50 lines if possible) that can be copy-pasted to
79+
reproduce the issue. The snippet should have **no external library dependencies**
80+
(i.e., use fake or mock data / environments).
81+
82+
**NOTE**: If the code snippet cannot be run by itself, the issue will be marked as "needs-repro-script"
83+
until the repro instruction is updated.
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
attributes:
89+
label: Anything else
90+
description: Anything else we need to know?
91+
placeholder: >
92+
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
93+
Any relevant logs to include? Are there other relevant issues?
94+
95+
- type: checkboxes
96+
attributes:
97+
label: Are you willing to submit a PR?
98+
description: >
99+
This is absolutely not required, but we are happy to guide you in the contribution process
100+
especially if you already have a good understanding of how to implement the fix.
101+
options:
102+
- label: Yes I am willing to submit a PR!
103+
104+
- type: markdown
105+
attributes:
106+
value: "Thanks for completing our form!"

.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: fasle
2+
contact_links:
3+
- name: Ask a question or get support
4+
url: https://github.com/WeBankFinTech/DataSphereStudio/discussions
5+
about: Ask a question or request support for using DSS
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: DSS feature request
2+
description: Suggest an idea for DSS project
3+
title: "[Feature] "
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for finding the time to propose a new feature!
10+
We really appreciate the community efforts to improve DSS.
11+
- type: checkboxes
12+
attributes:
13+
label: Search before asking
14+
description: >
15+
Please make sure to search in the [issues](https://github.com/WeBankFinTech/DataSphereStudio/issues) first to see
16+
whether the same feature was requested already.
17+
options:
18+
- label: >
19+
I had searched in the [issues](https://github.com/WeBankFinTech/DataSphereStudio/issues) and found no similar
20+
feature requirement.
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Problem Description
25+
description: Is your feature request related to a problem? Please describe.
26+
27+
- type: textarea
28+
attributes:
29+
label: Description
30+
description: A short description of your feature
31+
32+
- type: textarea
33+
attributes:
34+
label: Use case
35+
description: >
36+
Describe the use case of your feature request.
37+
placeholder: >
38+
Describe the solution you'd like A clear and concise description of what you want to happen.
39+
40+
- type: textarea
41+
attributes:
42+
label: solutions
43+
description: Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.
44+
45+
- type: textarea
46+
attributes:
47+
label: Anything else
48+
description: Anything else we need to know?
49+
placeholder: >
50+
Additional context Add any other context or screenshots about the feature request here.
51+
52+
- type: checkboxes
53+
attributes:
54+
label: Are you willing to submit a PR?
55+
description: >
56+
This is absolutely not required, but we are happy to guide you in the contribution process
57+
especially if you already have a good understanding of how to implement the feature.
58+
options:
59+
- label: Yes I am willing to submit a PR!
60+
61+
- type: markdown
62+
attributes:
63+
value: "Thanks for completing our form!"

.vscode/settings.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)