Skip to content

Commit

Permalink
chore: create refactor template md
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-mauran authored Nov 19, 2024
1 parent 75775d8 commit f89b852
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Refactor request
about: Propose improvements to the code structure or architecture
title: ""
labels: refactor
assignees: ""

---

### Problem

<!--
Describe the current issue with the codebase or specific part of the code that you believe need refactoring.
-->

---

### Proposed Refactor Plan

<!--
Provide a detailed plan for refactoring.
Consider including:
- Suggestions for breaking down large files (e.g., separating `board.rs` into smaller modules)
- Improving code structure or reducing duplication
- Enhancing testability or modularity of the codebase
- Potentially introducing design patterns or Rust best practices
-->

---

### Expected Benefits

<!--
Outline the benefits of the proposed refactor.
Examples:
- Easier maintainability and readability of the code
- Improved test coverage and debugging experience
- Better performance or reduced technical debt
-->

---

### Additional Context

<!--
Add any other context, such as:
- Relevant files or code snippets needing attention
- Links to documentation, tools, or examples to support your suggestion
-->

0 comments on commit f89b852

Please sign in to comment.