Skip to content

Commit 7cdbb36

Browse files
chore: add issue templates (#2086)
* Add issue templates [skip ci] * Apply suggestions from code review Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com> * Improve wording Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com>
1 parent b4e352f commit 7cdbb36

File tree

4 files changed

+123
-0
lines changed

4 files changed

+123
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
name: "\U0001F41B Bug Report"
3+
about: "Please report issues related to the TypeScript and HTML API of Vaadin components here."
4+
title: ''
5+
labels: 'i: needs triage'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill out each section below, otherwise, your issue risks taking an infinite amount of time to triage. This info allows the maintainers team to diagnose and fix your issue as quickly as possible.
12+
13+
Before opening a new issue, please search existing issues: https://github.com/vaadin/web-components/issues.
14+
-->
15+
16+
### Description
17+
18+
Describe the issue that you're seeing.
19+
20+
<!-- Example: The `vaadin-grid` element scrolls when applying filter. -->
21+
22+
### Expected outcome
23+
24+
What did you expect to happen?
25+
26+
<!-- Example: No scrolling should happen. -->
27+
28+
### Actual outcome
29+
30+
What happened instead.
31+
32+
<!-- Example: Grid content occasionally gets scrolled. -->
33+
34+
### Live Demo (optional)
35+
36+
A screenshot or video with issue reproduced.
37+
38+
### Minimal reproducible example
39+
40+
**Please** provide a demo project or code snippet that reproduces the issue, this _greatly_ increases the chance that we will be able to identify and fix the issue.
41+
42+
<!--
43+
```
44+
<vaadin-grid></vaadin-grid>
45+
```
46+
```
47+
const grid = document.querySelector('vaadin-grid');
48+
grid.items = items;
49+
```
50+
-->
51+
52+
### Steps to reproduce
53+
54+
Clear steps describing how to reproduce the issue.
55+
56+
<!-- Example
57+
1. Put a `vaadin-grid` element in the page.
58+
2. Add `vaadin-grid-filter` element to the column header template.
59+
3. Open the page in a web browser.
60+
4. Start typing in the filter input.
61+
-->
62+
63+
### Environment
64+
65+
- Version of the webcomponent / Vaadin platform.
66+
- OS.
67+
68+
<!-- Example:
69+
- v20.0.0
70+
- OSX 10.13.4
71+
-->
72+
73+
### Browsers Affected
74+
<!-- Check all that apply -->
75+
- [ ] Chrome
76+
- [ ] Firefox
77+
- [ ] Safari
78+
- [ ] Edge
79+
- [ ] IE 11
80+
- [ ] iOS Safari
81+
- [ ] Android Chrome

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: "I have a specific suggestion for the TypeScript and HTML API of Vaadin components!"
4+
title: ''
5+
labels: 'i: needs triage'
6+
assignees: ''
7+
8+
---
9+
10+
### Describe your motivation
11+
12+
A concise description of why you are proposing a change. For example, you would like a new feature to solve a use-case, or you want an existing feature changed because it is difficult to use.
13+
14+
### Describe the solution you'd like
15+
16+
Provide a clear and concise description of what you want to happen.
17+
18+
### Describe alternatives you've considered
19+
20+
Provide information about other solutions you've tried or researched.
21+
22+
### Additional context
23+
24+
Is there anything else you can add about the proposal?
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: "\U0001F917 Support Question"
3+
about: "If you have a question \U0001F4AC, please check out our Discord or StackOverflow!"
4+
title: ''
5+
labels: 'i: question, i: needs triage'
6+
assignees: ''
7+
8+
---
9+
10+
We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thank you!
11+
12+
---
13+
14+
* StackOverflow: https://stackoverflow.com/questions/tagged/vaadin using the tag `vaadin`
15+
* Discord: If it's just a quick question you can ask it on our Discord channel: https://discord.com/invite/MYFq5RTbBn
16+
* Also have a look at our website for more information on how to get support:
17+
https://vaadin.com/support

0 commit comments

Comments
 (0)