Skip to content

Commit

Permalink
doc: Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
JulesGresset authored Jan 23, 2025
1 parent f753f61 commit 1027ca8
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to log a bug
title: ''
labels: ''
assignees: ''

---

**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.

**Additional context**
Add any other context about the problem here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: New feature
about: Log a new feature
title: ''
labels: ''
assignees: ''

---

**Description**
Provide a clear and concise description of the new feature. Explain the problem it solves, the context where it will be used, and why it's important.

**Mockups/Screenshots**
*(Optional)* Attach any mockups, diagrams, or screenshots that illustrate the feature or its expected UI/UX.

**Acceptance Criteria**
Define the conditions under which this feature will be considered complete:
- [ ] *Criteria 1: Clear and measurable outcome.*
- [ ] *Criteria 2: Relevant tests and validations added.*
- [ ] *Criteria 3: User documentation updated (if applicable).*

**Additional Context**
Include any relevant technical considerations, dependencies, or potential challenges.

0 comments on commit 1027ca8

Please sign in to comment.