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

Commit b06e71e

Browse files
authored
chore: Update GitHub issue templates for the project (#25)
* feat: Add issue templates * Update ISSUE-TEMPLATE * chore: update gitmodules url for Lunar.Core.Base * Merge remote-tracking branch 'origin/main' * docs: add refactor request issue template
1 parent dbba18e commit b06e71e

File tree

5 files changed

+142
-2
lines changed

5 files changed

+142
-2
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: Bug report
3+
about: Report a bug or unexpected behavior in the C# library
4+
title: 'bug: [Short description]'
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### 🐛 Problem Description
11+
Provide a clear description of the issue. Include:
12+
- Library name and version (NuGet package or project)
13+
- Type of issue: compile-time / runtime / unexpected behavior
14+
- Short code snippet showing the context (optional, but helpful)
15+
16+
---
17+
18+
### 📝 Steps to Reproduce
19+
Provide a minimal, self-contained example:
20+
21+
```csharp
22+
// Minimal reproducible example
23+
using MyLibrary;
24+
25+
class Program
26+
{
27+
static void Main()
28+
{
29+
var obj = new Foo();
30+
obj.Bar(null); // Example of problematic call
31+
}
32+
}
33+
````
34+
35+
1. Which **class** and **method** did you call? What **parameters** did you pass?
36+
2. Operating system and .NET runtime version (e.g., Windows 11, .NET 8.0)
37+
3. How did you **install** and **reference** the library? (NuGet, version number, local reference, etc.)
38+
39+
---
40+
41+
### ✅ Expected Result
42+
43+
Describe what the correct behavior should be.
44+
Example:
45+
46+
* Method `Bar` should return a non-null string.
47+
* No exception should be thrown.
48+
49+
---
50+
51+
### 📄 Actual Result / Logs
52+
53+
Include any errors, stack traces, or console output:
54+
55+
```text
56+
System.NullReferenceException: Object reference not set to an instance of an object.
57+
at MyLibrary.Foo.Bar(String input) in Foo.cs:line 42
58+
```
59+
60+
---
61+
62+
### ⚙ Additional Information
63+
64+
* Is the library used in a multi-threaded environment?
65+
* Are there other libraries that might conflict?
66+
* Does the issue appear on specific hardware or OS versions?
67+
* Any workarounds tried?
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement for this project
4+
title: 'feat: [Brief description of the feature]'
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### 🔗 Is your feature request related to a specific issue?
11+
Please briefly describe the origin of this feature request. For example:
12+
- The library is missing [specific feature], which causes [specific problem]
13+
- You want to make certain scenarios easier by achieving [desired effect]
14+
15+
---
16+
17+
### 💡 Feature Description
18+
Explain in detail the feature you want to add or improve, including:
19+
- Expected outcome or effect
20+
- Specific implementation ideas, such as classes, methods, parameters, or API design
21+
- Usage scenarios or benefits
22+
23+
Example:
24+
- Add `Foo.BarAsync()` method to allow asynchronous processing without blocking the main thread
25+
- The goal is to improve performance and support multi-threaded environments
26+
27+
---
28+
29+
### ⚖ Alternatives Considered
30+
List other approaches you tried or considered, and explain why they are not ideal or feasible.
31+
32+
Example:
33+
- Tried using an extension method `FooExtensions` for async, but encountered state management issues
34+
- Existing approach only supports single-threaded scenarios and does not meet the requirements
35+
36+
---
37+
38+
### 📝 Additional Information
39+
Provide any extra background, design sketches, or code snippets to help developers better understand your idea.
40+
- If it involves other game engines, you can attach editor screenshots or diagrams
41+
- Include example usage or pseudocode if helpful
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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 or maintainability
13+
- Reducing complexity or technical debt
14+
- Adhering to new design principles or best practices
15+
16+
---
17+
18+
### 💡 Proposed Refactoring
19+
Explain the specific changes you want to make. Include:
20+
- A high-level overview of the proposed changes
21+
- Specific classes, methods, or components to be refactored
22+
- The expected outcome or benefit (e.g., better performance, easier to test)
23+
24+
---
25+
26+
### ⚖ Alternatives Considered
27+
List any other approaches or refactoring strategies you considered and explain why the proposed one is the best fit.
28+
29+
---
30+
31+
### 📝 Additional Information
32+
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.

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "src/Lunar.Core.Base"]
22
path = src/Lunar.Core.Base
3-
url = https://github.com/Bli-AIk/Lunar.Core.Base.git
3+
url = https://github.com/Lunar-Framework/Lunar.Core.Base.git

src/Lunar.Core.Base

0 commit comments

Comments
 (0)