docs: 优化文档结构并添加 GitHub 模板

2026-03-31 10:00:49 +08:00
parent 2e009cf59a
commit b1527d9575
5 changed files with 361 additions and 84 deletions
@@ -0,0 +1,41 @@
+---
+name: Issue Report
+about: Report a bug or suggest a feature
+title: '[ISSUE] '
+labels: ''
+assignees: ''
+---
+
+## Type
+Please select the type of this issue:
+- [ ] Bug Report
+- [ ] Feature Request
+
+## Description
+A clear and concise description of the issue or suggestion.
+
+## Steps to Reproduce (for bugs)
+1. 
+2. 
+3. 
+
+## Expected Behavior (for bugs)
+What you expected to happen.
+
+## Actual Behavior (for bugs)
+What actually happened.
+
+## Solution Proposal (for features)
+Describe the solution you'd like.
+
+## Alternatives Considered (for features)
+Describe any alternative solutions or features you've considered.
+
+## Environment (for bugs)
+- Python version:
+- AstrAI version (or commit hash):
+- OS:
+- GPU (if applicable):
+
+## Additional Context
+Add any other context, screenshots, or logs here.
@@ -0,0 +1,26 @@
+## Description
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+
+Fixes # (issue number)
+
+## Type of Change
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Other (please describe):
+
+## How Has This Been Tested?
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
+
+## Checklist:
+- [ ] My code follows the style guidelines of this project (run `ruff format .` and `ruff check --fix .`)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules