Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-632]: Update issue templates #1849

Merged
merged 2 commits into from
Sep 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]

Check failure on line 26 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L26

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 26, "column": 9}}}, "severity": "ERROR"}
- Browser [e.g. chrome, safari]

Check failure on line 27 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L27

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 27, "column": 13}}}, "severity": "ERROR"}
- Version [e.g. 22]

Check failure on line 28 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L28

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 28, "column": 13}}}, "severity": "ERROR"}

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]

Check failure on line 31 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L31

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 31, "column": 13}}}, "severity": "ERROR"}
- OS: [e.g. iOS8.1]

Check failure on line 32 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L32

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 32, "column": 9}}}, "severity": "ERROR"}
- Browser [e.g. stock browser, safari]

Check failure on line 33 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L33

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 33, "column": 13}}}, "severity": "ERROR"}
- Version [e.g. 22]

Check failure on line 34 in .github/ISSUE_TEMPLATE/bug_report.md

View workflow job for this annotation

GitHub Actions / vale

[vale] .github/ISSUE_TEMPLATE/bug_report.md#L34

[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.
Raw output
{"message": "[Viam.AvoidObscure] Use 'for example, such as' instead of 'e.g'.", "location": {"path": ".github/ISSUE_TEMPLATE/bug_report.md", "range": {"start": {"line": 34, "column": 13}}}, "severity": "ERROR"}

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'feature'

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other
about: File a general ticket
title: ''
labels: 'general'

---

**Context**
Add any other context or screenshots about the ticket here.
Loading