Skip to content

Commit

Permalink
Update issue templates (#271)
Browse files Browse the repository at this point in the history
* add issue templates

* Updates

---------

Co-authored-by: Mikhail Volkov <mikhail@volkovlabs.io>
  • Loading branch information
vitPinchuk and mikhail-vl authored Feb 28, 2025
1 parent 0106bf1 commit 7da6080
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: vitPinchuk
projects: ['Volkovlabs/10']
---

<!-- Please use this template to submit bug reports. Filling out the sections below will help us investigate and resolve the issue faster. -->

## Summary

A clear and concise description of the bug (e.g., "Dashboard crashes when selecting XYZ option").

## Steps to Reproduce

Provide detailed steps to replicate the issue:

1. [e.g., Go to the Dashboards page]
2. [e.g., Click the XYZ button]
3. [e.g., Select option ABC]
4. [e.g., Observe the error]
**Tip:** Attach a screen recording, screenshot, or log file (use ``` for logs) to illustrate the issue.

## Did This Work Before?

- [ ] Yes
- [ ] No

If yes, specify the versions where it worked:

- **Plugin Version:** [e.g., 2.5.0]
- **Grafana Version:** [e.g., 11.0.0]

## Expected Result

Describe what you expected to happen (e.g., "The dashboard should load without errors").

## Actual Result

Describe what actually happened, including:

- Error messages (if any, use ``` for formatting).
- Unexpected behavior.
- Attach screenshots or logs if applicable.

## Environment

Details about your setup:

- **Plugin Version:** [e.g., 2.5.0]
- **Grafana Version:** [e.g., 11.0.0]
- **Datasource(s):** [e.g., Prometheus, MySQL]
- **Operating System:** [e.g., Ubuntu 20.04] (optional)
- **Browser:** [e.g., Chrome 120] (optional)

## Additional Context (Optional)

Any extra details that might help, such as:

- Recent changes (e.g., upgrades, config edits).
- Frequency of the issue (e.g., always, intermittent).

---

Thank you for reporting this issue! We’ll look into it and respond as soon as possible.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: vitPinchuk
projects: ['Volkovlabs/10']
---

<!-- Please use this template for submitting feature requests. Providing detailed information will help us evaluate and prioritize your suggestion. -->

## Why Is This Needed?

Describe the problem this feature would solve or the use case it addresses.

- What challenge are you facing without this feature?
- How would it improve your experience?

## What Would You Like to Be Added?

Provide a clear and concise description of the feature or enhancement.

- What should it do?
- Include any specific functionality or behavior you envision (e.g., new UI element, API support).

## Who Is This Feature For?

Explain the target audience for this feature.

- What type of user would benefit (e.g., developers, admins, end-users)?
- How broadly do you think it would be used?

## Additional Context (Optional)

Add any extra details, such as:

- Examples from other tools/projects with similar features.
- Mockups, sketches, or screenshots (if applicable).
- Relevant workflows or scenarios.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Question
about: Ask a question about this project
title: ''
labels: question
assignees: vitPinchuk
projects: ['Volkovlabs/10']
---

<!-- Please use this template to ask questions about this project. Filling out the sections below will help us respond more effectively. -->

## Your Question

A clear and concise question about the project (e.g., "How do I configure XYZ feature?").

## Context and Details

Help us understand your situation by including:

- **What you're trying to achieve:** A brief description of your goal.
- **What you've tried so far:** Any solutions or troubleshooting steps you’ve attempted.
- **Additional information:** Logs, error messages, screenshots, or other relevant details (please use code blocks ``` for logs or code snippets).

## Environment (if applicable)

Provide details about your setup to help us pinpoint the issue:

- **Plugin Version:** [e.g., 2.5.0]
- **Grafana Version:** [e.g., 11.0.0]
- **Datasource(s):** [e.g., Prometheus, MySQL]
- **Operating System:** [e.g., Ubuntu 20.04, Windows 10] (optional)

## Anything Else?

Add any other details you think might be helpful (optional).

---

Thank you for using this template! We’ll do our best to assist you promptly.

0 comments on commit 7da6080

Please sign in to comment.