Skip to content

Commit

Permalink
feat: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jahwag committed Sep 18, 2024
1 parent 471a399 commit d3d341b
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 64 deletions.
64 changes: 24 additions & 40 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,31 @@
---
name: Bug report
about: Create a report to help us improve ClaudeSync
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Run command '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
### 🐞 ClaudeSync Bug Report

**Error messages**
If applicable, provide the full error message or stack trace.
**1. Environment**
- **OS:** *e.g., Windows 10, macOS 12.3, Ubuntu 22.04*
- **Python Version:** *e.g., 3.9.7*
- **ClaudeSync Version:** *e.g., 1.2.3*
- **Installation Type:** *New / Upgraded*

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Windows 10, macOS 11.4, Ubuntu 20.04]
- Python version: [e.g. 3.8.10]
- ClaudeSync version: [e.g. 0.4.9]
**2. Configuration**
```bash
claudesync config ls
```
*(Please remove any sensitive information)*

**Configuration**
Please provide the output of `claudesync config ls` (make sure to remove any sensitive information).
**3. Steps to Reproduce**
1. *Step one*
2. *Step two*
3. *Step three*

**Additional context**
Add any other context about the problem here. For example:
- Are you using any custom configurations?
- Did this issue start happening recently, or has it always been a problem?
- Can you reliably reproduce this issue? If not, how often does it occur?
**4. Description**
*What went wrong?*

**Logs**
If possible, please provide relevant logs. You can increase the log verbosity by running:
```
**5. Optional: Logs**
```bash
claudesync config set log_level DEBUG
# Paste logs here
```
Then reproduce the issue and provide the logs (make sure to remove any sensitive information).

---

### 🙏 Thank You for Your Contribution!
44 changes: 20 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
---
name: Feature request
about: Suggest an idea for ClaudeSync
title: ''
labels: enhancement
assignees: ''
### 🌟 Feature Request

---
**1. Feature Title**
> *A short, descriptive title for the feature.*
# Feature Request Template
**2. Description**
> *Describe the feature you’d like to see implemented.*
## 1. Problem Description
Provide a clear and concise description of the problem you're experiencing. For example: "I'm always frustrated when [...]"
**3. Benefits**
> *Explain how this feature will improve ClaudeSync or benefit users.*
## 2. Desired Solution
Outline the solution you would like to see implemented. Be clear and specific about what you want to happen.
**4. Use Case**
> *Provide a specific example of how you would use this feature.*
## 3. Considered Alternatives
Describe any alternative solutions or features you have considered. Include why these alternatives may or may not work for your needs.
**5. Environment (if applicable)**
- **OS:** e.g., Windows 10, macOS 12.3, Ubuntu 22.04
- **Python Version:** e.g., 3.9.7
- **ClaudeSync Version:** e.g., 1.2.3

## 4. Use Case
Explain how you would use this feature and how it would benefit your workflow with ClaudeSync.
**6. Willingness to Help**
> *Are you interested in contributing to this feature? (Yes/No)*
## 5. Additional Context
Include any other relevant context, screenshots, or examples that can help in understanding the feature request.
**7. Additional Context (optional)**
> *Any other relevant information, screenshots, or examples.*
---

## 6. Environment (if relevant)
- **OS:** [e.g. Windows 10, macOS 11.4, Ubuntu 20.04]
- **Python version:** [e.g. 3.8.10]
- **ClaudeSync version:** [e.g. 0.3.7]
### 🙏 Thank You for Your Contribution!

## 7. Willingness to Contribute
Let us know if you're interested in helping to implement this feature or if you're just suggesting an idea.

0 comments on commit d3d341b

Please sign in to comment.