Skip to content

Commit

Permalink
issue and bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
MauroMendizabal committed Jan 16, 2025
1 parent 6c1392f commit 1e7aa2e
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATES/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## **Bug Title**:
Provide a concise title summarizing the problem.

---

## **Description**:
A clear and concise description of the bug.
Include information about what is happening versus what you expected to happen.

---

## **Steps to Reproduce**:
List the steps to reproduce the bug. Be as specific as possible.
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

---

## **Expected Behavior**:
Describe what you expected to happen.

---

## **Actual Behavior**:
Describe what actually happens. Include any error messages or screenshots if applicable.

---

## **Environment**:
Provide information about the environment where the bug occurred.
- **OS**: (e.g., Windows 10, macOS 13.1, Ubuntu 20.04)
- **Python version**: (e.g., 3.10)
- **Dependencies**: (list specific library/package versions, if relevant)
- **Branch/Commit**: (e.g., main, commit hash `abc123`)

---

## **Screenshots/Logs**:
Attach screenshots, log outputs, or any other helpful artifacts.
(If applicable, paste stack traces or error messages here using code blocks like below.)

```text
Error message or logs here
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATES/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## **ISSUE Title**:
Provide a short and descriptive action-oriented title.

---

## **Goal(s)**:
Explain why and what needs to be achieved in one sentence.
For example:
*To decide between solution A or B because of X or Y.*

---

## **Description**:
Provide context or assumptions relevant to this issue.
If the issue is part of an Epic, mention previous progress or dependencies.
Example:
*We assume A and B are completed; this issue focuses on C.*

**Steps/Actions**:
1. C.1 for reason X
2. C.2 for reason Y

Notes:
- Add technical details here if not included in the Epic.
- If discussions were held, summarize key points.

---

## **Acceptance Criteria**:
Define the conditions for completing this issue.
Use the **GIVEN -> WHEN -> THEN** format if helpful.
Example:
**GIVEN** that the AOM (EOM) feature is enabled,
**WHEN** I compare simulation results from EMU-TN and Pulser,
**THEN** the results should look "close enough."

---

## **Before Creating This Ticket**:
- [ ] Ensure the **NEW** label is attached.
- [ ] Link this issue to its corresponding Epic if applicable.

0 comments on commit 1e7aa2e

Please sign in to comment.