Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: 🐛 Bug Report
about: Report a bug to help us improve QuantMind
title: 'bug: [brief description of the bug]'
labels: ['bug', 'needs-triage']
assignees: ''
---

## 🐛 Bug Description

<!-- A clear and concise description of what the bug is. -->

## 🔄 Steps to Reproduce

1. <!-- First step -->
2. <!-- Second step -->
3. <!-- ... -->

## ✅ Expected Behavior

<!-- A clear and concise description of what you expected to happen. -->

## ❌ Actual Behavior

<!-- A clear and concise description of what actually happened. -->

## 📋 Environment

- **QuantMind Version**: <!-- e.g., v0.2.0 -->
- **Python Version**: <!-- e.g., 3.9.7 -->
- **Operating System**: <!-- e.g., macOS 12.6, Ubuntu 22.04, Windows 11 -->
- **Installation Method**: <!-- e.g., pip, uv, source -->

## 📝 Additional Context

<!-- Any other context about the problem here. Include screenshots, error logs, or stack traces if helpful. -->

### Error Logs

```
<!-- Paste any relevant error messages or logs here -->
```

### Configuration

```yaml
# If relevant, paste your QuantMind configuration here
```

## 🛠️ Possible Solution

<!-- If you have suggestions on how to fix the bug, please describe them here. -->

---

**Checklist**

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have provided a clear and concise description
- [ ] I have included steps to reproduce the issue
- [ ] I have included my environment information
- [ ] I have included relevant error logs or screenshots
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
name: ✨ Feature Request
about: Suggest a new feature or enhancement for QuantMind
title: 'feat: [brief description of the feature]'
labels: ['enhancement', 'needs-triage']
assignees: ''
---

## ✨ Feature Summary

<!-- A clear and concise description of the feature you'd like to see implemented. -->

## 🎯 Motivation

<!-- Why is this feature needed? What problem does it solve? -->

## 📋 Detailed Description

<!-- Describe the feature in detail. How should it work? -->

## 🔧 Proposed Implementation

<!-- If you have ideas on how this could be implemented, describe them here. -->

### API Design

```python
# If applicable, show how you envision the API would look
```

### Configuration

```yaml
# If applicable, show any new configuration options
```

## 🎨 User Experience

<!-- Describe how users would interact with this feature. Include examples of usage. -->

## 📊 Use Cases

<!-- Describe specific use cases where this feature would be valuable. -->

1. **Use Case 1**: <!-- Description -->
2. **Use Case 2**: <!-- Description -->
3. **Use Case 3**: <!-- Description -->

## 🔗 Related Issues

<!-- Link to any related issues, discussions, or PRs -->

- Relates to #<!-- issue number -->
- Blocks #<!-- issue number -->
- Depends on #<!-- issue number -->

## Implementation Considerations

<!-- Any technical challenges, breaking changes, or compatibility concerns? -->

### Breaking Changes

- [ ] This feature would introduce breaking changes
- [ ] This feature is backward compatible

### Dependencies

- [ ] Requires new dependencies
- [ ] Uses existing dependencies only

---

**Checklist**

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have provided a clear and detailed description
- [ ] I have explained the motivation and use cases
- [ ] I have considered the implementation approach
- [ ] I have thought about potential breaking changes
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It'll be great if relevant reviewers can be assigned as well.-->

Please feel free to remove inapplicable items for your PR.

- [ ] The PR title starts with [$CATEGORY] (such as [Docs], [Fix], [Feature], [Refactor])
- [ ] The PR title starts with `$CATEGORY(xx): xxx` (such as `feat(tool): xxx`, `fix(source): xxx`, `docs(README): xxx`)
- [ ] Related issue is referred in this PR
- [ ] The markdown and latex are rendered correctly.
- [ ] The code in PR is well-documented.
Expand Down
Loading