Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

Commit 6d6506a

Browse files
committed
docs: add refactor request issue template
1 parent 3617172 commit 6d6506a

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Refactor request
3+
about: Suggest improvements to the project's code structure or design
4+
title: 'refactor: [Brief description of the refactoring]'
5+
labels: refactor
6+
assignees: ''
7+
8+
---
9+
10+
### 🧐 Why is this refactoring necessary?
11+
Describe the reason for this refactoring, such as:
12+
- Improving code readability, maintainability, or performance of the C# adapter/bridge library.
13+
- Reducing technical debt or complexity.
14+
- Adhering to new design principles or best practices for the library.
15+
- Addressing a recurring issue or pattern identified from bug reports.
16+
17+
---
18+
19+
### 💡 Proposed Refactoring
20+
Explain in detail the proposed changes to the C# adapter/bridge library, including:
21+
- A high-level overview of the proposed refactoring.
22+
- Specific classes, methods, or components to be refactored (e.g., `MyLibrary.Core.Bridge`, `Foo.Bar()`).
23+
- The expected outcome or benefit (e.g., better performance, easier to test, improved API design).
24+
- Engine-specific context: Editor mode / Play mode / Target platform / Scripting backend.
25+
26+
---
27+
28+
### ⚖ Alternatives Considered
29+
List any other approaches or refactoring strategies you considered and explain why the proposed one is the best fit for the C# adapter/bridge library.
30+
31+
Example:
32+
- Tried a different memory management approach, but it introduced more overhead.
33+
- Existing single-threaded implementation does not scale well in multi-threaded environments.
34+
35+
---
36+
37+
### 📝 Additional Information
38+
Provide any extra context, design sketches, or code snippets that would help explain the refactoring idea. This could include before-and-after examples or diagrams specific to the C# adapter/bridge library.
39+
- Include example usage, pseudocode, or small scripts.
40+
- Attach screenshots or diagrams if the refactoring involves editor integration or specific game engine scenarios.

0 commit comments

Comments
 (0)