Skip to content

Commit

Permalink
docs: added issues template
Browse files Browse the repository at this point in the history
  • Loading branch information
shanto268 committed Oct 20, 2024
1 parent 0c12c64 commit aa01157
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F41B Bug report"
about: "Create a report to help us improve \U0001F914."
title: ''
labels: bug
assignees: ''
---

<!-- ⚠️ Please abide by this template, otherwise you run the risk of the issue being closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues -->

### Information

- **Qiskit Metal version**:
- **Python version**:
- **Operating system**:

### What is the current behavior?

### Steps to reproduce the problem

### What is the expected behavior?

### Suggested solutions
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "\U0001F680 Feature request"
about: "Suggest an idea for this project \U0001F4A1!"
title: ''
labels: enhancement
assignees: ''
---

<!-- ⚠️ Please abide by this template, otherwise you run the risk of the issue being closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues to confirm this idea does not exist. -->

Please be as descriptive as possible, including: what is expected, why is this feature needed, what is the objective, etc.

### What is the feature being requested?

### What are use cases for this feature?
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/GENERAL_ISSUE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: General Issue
about: Report any other issue not covered by specific templates
title: '[ISSUE] '
labels: question, help wanted
assignees: ''
---

<!-- ⚠️ Please abide by this template, otherwise you run the risk of the issue being closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues -->

**Describe the issue**
Provide a clear and concise description of your issue.

**Steps to Reproduce**
(Optional) Provide steps to reproduce the issue (if applicable).

**Expected behavior**
A brief description of what you expected to happen.

**Actual behavior**
A brief description of what is happening instead.

**Screenshots**
If applicable, provide screenshots or logs to help illustrate the issue.

**Environment details (please complete the following information):**

- OS: [e.g., macOS, Ubuntu, Windows]
- Version: [e.g., 10.15.7]
- Software version: [e.g., v1.2.3]

**Additional context**
Add any other context, logs, or configuration files that could help diagnose the issue.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/INSTALLATION_ISSUE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Installation Issue
about: Report any issues related to installing `SQuADDS`
title: '[INSTALLATION] '
labels: installation, bug
assignees: ''
---

<!-- ⚠️ Please abide by this template, otherwise you run the risk of the issue being closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues -->

**Describe the issue**
A clear and concise description of the installation issue you are facing.

**Steps to Reproduce**
Steps to reproduce the behavior (if applicable):

1. What operating system and environment are you using (e.g., OS version, Docker, Virtual Machine, etc.)?
2. What command or setup instructions are you running?
3. Include the output or error message if available.

**Expected behavior**
A clear and concise description of what you expected to happen during the installation or setup.

**Screenshots**
If applicable, add screenshots or log output to help explain the problem.

**Environment details (please complete the following information):**

- OS: [e.g., macOS, Ubuntu, Windows]
- Version: [e.g., 10.15.7]
- Python Version: [e.g., 3.8]
- Any additional dependencies or tools being used

**Additional context**
Add any other context about the installation problem here.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tutorials/figures/*
tutorials/new_interp*.png
tutorials/*parquet*.py
tutorials/adhish.ipynb
tutorials/sims/*
tutorials/temp.sh

# Ignore documentation build directories
docs/_build/
Expand Down

0 comments on commit aa01157

Please sign in to comment.