Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
New issue draft for creating classes
  • Loading branch information
FMorschel authored Feb 9, 2024
1 parent 115b0b6 commit 8704925
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ A clear and concise description of what you expected to happen.
**Additional context**
Add any other context about the problem here. Other related issues could be mentioned here.

---

- [ ] **Search for Existing Issues**: I have searched for existing issues related to this bug and found none.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/class-creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Class creation
about: Draft for a class that solves another issue
title: Creation of [Class Name]
labels: class_creation, enhancement, feature
assignees: FMorschel

---

### Overview
The proposal is to introduce a new class, [Class Name], to enhance the capabilities of the package. This class is designed to [provide a brief description of the purpose and functionality of the new class].

**Related to**: [List all issues related to this here]

### Proposed Class
**[Class Name]**
**Purpose**: [Describe the main purpose and use case of the class].
**Parameters**: [List the relevant parameters and their significance].
**Usage Example**:

```dart
//Example of usage here
```

### Benefits
**Increased Functionality**: The addition of [Class Name] will enhance the package's functionality, catering to specific use cases.

**Improved Code Organization**: This new class contributes to better code organization by encapsulating [mention any specific logic or functionality it encapsulates].

**Usability Enhancement**: Users can benefit from [Class Name] by [highlight any advantages or scenarios where it is particularly useful].

### Additional Information
**Dependencies**: [Specify if the new class has any dependencies].
**Testing**: [Briefly mention the testing process and any relevant test cases].

---

Your feedback on this proposal is highly encouraged. If approved, I will proceed with the implementation and submit a pull request.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ A clear and concise description of any alternative solutions or features you've
**Additional context**
Add any other context or screenshots about the feature request here. Other related issues could be mentioned here.

---

- [ ] **Search for Existing Issues**: I have searched for existing issues related to this functionality.

0 comments on commit 8704925

Please sign in to comment.