Initial commit

This commit is contained in:
Zhongwei Li
2025-11-29 18:20:07 +08:00
commit 366407c7c0
10 changed files with 295 additions and 0 deletions

View File

@@ -0,0 +1,27 @@
# [Chore Name]
<purpose>
What maintenance task, tooling update, or dependency change is needed and why.
</purpose>
<changes>
What will be changed:
- Dependency updates
- Configuration changes
- Build/CI improvements
- Tooling modifications
</changes>
<impact>
Impact on the project:
- Breaking changes (if any)
- Required developer actions
- Environment or setup changes
</impact>
<verification>
How to verify the changes work:
- Build/CI checks
- Local development verification
- Deployment verification (if applicable)
</verification>

View File

@@ -0,0 +1,28 @@
# [Documentation Update]
<purpose>
What documentation needs to be created or updated and why.
</purpose>
<scope>
What will be documented:
- Topic or feature area 1
- Topic or feature area 2
- Topic or feature area 3
</scope>
<content_outline>
High-level structure of the documentation:
- Section 1: Brief description
- Section 2: Brief description
- Section 3: Brief description
Include audience (developers, users, etc.) and tone/style considerations.
</content_outline>
<completion_criteria>
How to verify documentation is complete:
- Coverage check 1
- Coverage check 2
- Accuracy verification steps
</completion_criteria>

View File

@@ -0,0 +1,27 @@
# [Feature Name]
<purpose>
What feature is being added and why it's needed.
</purpose>
<requirements>
- User story or requirement 1
- User story or requirement 2
- User story or requirement 3
</requirements>
<implementation>
High-level approach:
- Architecture pattern or design choice
- Key components or modules involved
- Important technical considerations
Avoid detailed code - focus on structure and decisions.
</implementation>
<testing>
Verification plan:
- Functional test scenario 1
- Functional test scenario 2
- Edge cases to verify
</testing>

View File

@@ -0,0 +1,25 @@
# [Bug Fix Name]
<problem>
Description of the bug or issue. What is broken and how it manifests.
</problem>
<root_cause>
Why the bug occurs - the underlying cause.
</root_cause>
<solution>
How to fix it:
- Approach to resolve the issue
- Components that need changes
- Any side effects to consider
Keep implementation details minimal.
</solution>
<testing>
How to verify the fix:
- Reproduce steps that should now work
- Regression tests to ensure nothing breaks
- Edge cases related to the bug
</testing>

View File

@@ -0,0 +1,25 @@
# [Refactoring Name]
<motivation>
Why this refactoring is needed - code quality issues, maintainability concerns, or technical debt.
</motivation>
<current_state>
Brief description of what exists now that needs refactoring.
</current_state>
<target_state>
What the code should look like after refactoring:
- Structural improvements
- Pattern or architecture changes
- Quality improvements (readability, maintainability, performance)
Focus on design and structure, not specific code.
</target_state>
<testing>
How to ensure refactoring doesn't break functionality:
- Existing tests that should pass
- New tests if behavior changes
- Performance benchmarks if applicable
</testing>

View File

@@ -0,0 +1,26 @@
# [Title]
<purpose>
Brief description of what needs to be accomplished and why.
</purpose>
<requirements>
- Requirement 1
- Requirement 2
- Requirement 3
</requirements>
<implementation>
High-level technical approach and key decisions. Avoid specific code details.
Keep this concise - focus on architecture, patterns, and important constraints rather than detailed implementation.
If code examples are necessary, keep them minimal and illustrative only.
</implementation>
<testing>
How to verify the implementation:
- Test scenario 1
- Test scenario 2
- Test scenario 3
</testing>