Skip to content

Commit

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

* Run IDE autoformatting on issue templates
  • Loading branch information
f-PLT authored Jan 19, 2025
1 parent 1d40978 commit 5ae7765
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Bug report
about: Create a report to describe the bug
title: Fix ...
labels: bug
assignees: ''

---

## Summary

Brief description of the bug (tl;dr).

## Detailed Description

A clear and detailed description of what the bug is, what is affected by it and why it's important to fix it.

Don't forget to add the other appropriate labels and link the issue to a milestone if applicable.

## Possible Fix Implementation

If possible, break down the tasks or steps needed to fix the bug.

Consider including:

- Approximate timeline
- Specific files or areas in the codebase concerned
- Possible problems or complications

## How to Reproduce the Bug

### Environment

(please complete the following information)

- OS and/or device: [e.g. iOS, Windows, Android, etc.]
- Browser [e.g. chrome, safari]
- Version [e.g. Production, Development, etc.]

### Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Screenshots

If applicable, add screenshots to help explain your problem.

## Additional context

Add any other context about the problem here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/new-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: New Issue
about: Create a new issue for the project
title: ''
labels: ''
assignees: ''

---

## Summary

Brief description of the issue (tl;dr).

## Detailed Description

Detailed description of the issue and why it is important. You can also talk about proposed ways to solve the issue if
the path forward is not clear.

Don't forget to add the appropriate labels and link the issue to a milestone if applicable.

## Implementation Details

If possible, break down the tasks or steps needed to complete the solution.

Consider including:

- Approximate timeline
- Specific files or areas in the codebase concerned
- Possible problems or complications

## Related Issues

If applicable, list of related issues

## Additional Context

Add any other context or screenshots here.

0 comments on commit 5ae7765

Please sign in to comment.