Skip to content

Commit f1a180d

Browse files
m96-chanclaude
m96-chan
and
claude
committed
Add comprehensive GitHub issue templates
Created 5 specialized issue templates: 1. 🐛 Bug Report (bug_report.yml) - Detailed reproduction steps - System information (Python, Windows, target process) - Error logs and minimal reproducible examples 2. ✨ Feature Request (feature_request.yml) - Problem statement and proposed solution - Use cases and example API - Implementation willingness checkboxes 3. ⚡ Performance Issue (performance.yml) - Quantitative performance measurements - Profiling data and optimization ideas - Comparison with alternatives 4. 🔧 Type Hints / Async Extension (type_hints_async.yml) - Type annotation improvements - Async API enhancements - mypy compatibility 5. 📚 Documentation Improvement (documentation.yml) - README, API reference, examples - Code samples and clarity improvements - Translation support Also added config.yml to: - Disable blank issues - Link to Discussions, Documentation, and existing issues These templates will guide contributors to provide structured, actionable information for all types of contributions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3191833 commit f1a180d

6 files changed

Lines changed: 664 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in ProcTap
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the following information to help us reproduce and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Install ProcTap with '...'
27+
2. Run script with '...'
28+
3. Observe error '...'
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: The audio should be captured without errors...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened?
46+
placeholder: Instead, I got an error...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: code
52+
attributes:
53+
label: Minimal Reproducible Example
54+
description: Provide a minimal code example that reproduces the issue
55+
placeholder: |
56+
```python
57+
from proctap import ProcessAudioTap
58+
59+
# Your code here
60+
```
61+
render: python
62+
63+
- type: input
64+
id: version
65+
attributes:
66+
label: ProcTap Version
67+
description: What version of ProcTap are you using?
68+
placeholder: "0.1.0 (from `pip show proc-tap`)"
69+
validations:
70+
required: true
71+
72+
- type: input
73+
id: python-version
74+
attributes:
75+
label: Python Version
76+
description: What version of Python are you using?
77+
placeholder: "3.11.5 (from `python --version`)"
78+
validations:
79+
required: true
80+
81+
- type: input
82+
id: windows-version
83+
attributes:
84+
label: Windows Version
85+
description: What version of Windows are you using?
86+
placeholder: "Windows 11 22H2 (from `winver`)"
87+
validations:
88+
required: true
89+
90+
- type: dropdown
91+
id: process-type
92+
attributes:
93+
label: Target Process Type
94+
description: What type of process were you trying to capture audio from?
95+
options:
96+
- Game (VRChat, etc.)
97+
- Browser (Chrome, Firefox, etc.)
98+
- Media Player (Spotify, etc.)
99+
- Communication App (Discord, Zoom, etc.)
100+
- DAW / Music Production
101+
- Other
102+
validations:
103+
required: true
104+
105+
- type: textarea
106+
id: error-log
107+
attributes:
108+
label: Error Messages / Logs
109+
description: Please copy and paste any relevant error messages or logs
110+
placeholder: Paste full error traceback here...
111+
render: shell
112+
113+
- type: textarea
114+
id: additional
115+
attributes:
116+
label: Additional Context
117+
description: Add any other context about the problem here (screenshots, etc.)
118+
placeholder: Any additional information that might help...

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/m96-chan/ProcTap/discussions
5+
about: Ask questions, share ideas, or discuss ProcTap with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/m96-chan/ProcTap/blob/main/README.md
8+
about: Read the official documentation, examples, and guides
9+
- name: 🔍 Existing Issues
10+
url: https://github.com/m96-chan/ProcTap/issues
11+
about: Search existing issues before creating a new one

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
name: 📚 Documentation Improvement
2+
description: Suggest improvements to documentation, examples, or guides
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve ProcTap's documentation!
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation needs improvement?
16+
options:
17+
- README.md
18+
- API Reference / Docstrings
19+
- Code Examples
20+
- Tutorial / Guide
21+
- Installation Instructions
22+
- Troubleshooting Guide
23+
- CLAUDE.md (Developer Guide)
24+
- Type Stubs (.pyi files)
25+
- Inline Code Comments
26+
- Other
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: issue
32+
attributes:
33+
label: Documentation Issue
34+
description: Describe what's missing, unclear, or incorrect in the documentation
35+
placeholder: |
36+
The documentation doesn't explain how to...
37+
The example code is confusing because...
38+
The installation instructions are missing...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: location
44+
attributes:
45+
label: Location
46+
description: Where is the documentation issue located?
47+
placeholder: |
48+
- File: README.md, section "Basic Usage"
49+
- Line 42 in src/proctap/core.py docstring
50+
- examples/record_proc_to_wav.py
51+
render: markdown
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: current-content
57+
attributes:
58+
label: Current Content (If Applicable)
59+
description: Quote or paste the current documentation that needs improvement
60+
placeholder: |
61+
Currently says:
62+
"Use ProcessAudioTap to capture audio."
63+
render: markdown
64+
65+
- type: textarea
66+
id: proposed-content
67+
attributes:
68+
label: Proposed Improvement
69+
description: What should the documentation say instead?
70+
placeholder: |
71+
Should say:
72+
"ProcessAudioTap captures audio from a specific Windows process by PID.
73+
Example: `tap = ProcessAudioTap(pid=12345)`"
74+
render: markdown
75+
validations:
76+
required: true
77+
78+
- type: dropdown
79+
id: audience
80+
attributes:
81+
label: Target Audience
82+
description: Who would benefit from this documentation improvement?
83+
options:
84+
- Beginners (new to ProcTap)
85+
- Intermediate Users
86+
- Advanced Users / Contributors
87+
- All Users
88+
validations:
89+
required: true
90+
91+
- type: checkboxes
92+
id: doc-scope
93+
attributes:
94+
label: Documentation Scope
95+
description: What aspects should the improved documentation cover?
96+
options:
97+
- label: Clear explanation of concepts
98+
- label: Working code examples
99+
- label: Common pitfalls / gotchas
100+
- label: Performance considerations
101+
- label: Type hints and signatures
102+
- label: Error handling
103+
- label: Platform-specific notes (Windows versions)
104+
- label: Integration examples (Discord, etc.)
105+
106+
- type: textarea
107+
id: example-code
108+
attributes:
109+
label: Example Code (Optional)
110+
description: If you're suggesting a code example, provide it here
111+
placeholder: |
112+
```python
113+
from proctap import ProcessAudioTap
114+
115+
# Example demonstrating the concept
116+
```
117+
render: python
118+
119+
- type: textarea
120+
id: related-issues
121+
attributes:
122+
label: Related Issues / Questions
123+
description: Link to related issues, discussions, or questions
124+
placeholder: |
125+
- Related to #123
126+
- Users asked about this in Discussion #456
127+
- Stack Overflow question: https://...
128+
129+
- type: checkboxes
130+
id: languages
131+
attributes:
132+
label: Language / Translation
133+
description: Does this involve translation or localization?
134+
options:
135+
- label: English documentation improvement
136+
- label: Add Japanese translation
137+
- label: Add other language translation
138+
- label: Fix grammar / spelling
139+
140+
- type: checkboxes
141+
id: implementation
142+
attributes:
143+
label: Implementation Willingness
144+
description: Can you help improve the documentation?
145+
options:
146+
- label: I can submit a PR with the documentation changes
147+
- label: I can write example code
148+
- label: I can review/proofread changes
149+
- label: I can help translate
150+
151+
- type: textarea
152+
id: additional
153+
attributes:
154+
label: Additional Context
155+
description: Any other information about the documentation improvement
156+
placeholder: Screenshots, links to good documentation examples from other projects, etc.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement for ProcTap
3+
title: "[Feature]: "
4+
labels: ["enhancement", "feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm frustrated when... / It would be useful if...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like to see
25+
placeholder: I would like ProcTap to support...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered
34+
placeholder: I also considered... / Another approach might be...
35+
36+
- type: textarea
37+
id: use-case
38+
attributes:
39+
label: Use Case
40+
description: Describe your use case and how this feature would help
41+
placeholder: |
42+
I want to use ProcTap for...
43+
This feature would enable me to...
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: example
49+
attributes:
50+
label: Example API (Optional)
51+
description: If applicable, show what the API might look like
52+
placeholder: |
53+
```python
54+
from proctap import ProcessAudioTap
55+
56+
# Example of how the feature might work
57+
tap = ProcessAudioTap(pid=1234, new_feature=True)
58+
```
59+
render: python
60+
61+
- type: dropdown
62+
id: category
63+
attributes:
64+
label: Feature Category
65+
description: Which category does this feature belong to?
66+
options:
67+
- Audio Capture (core functionality)
68+
- API Design (usability, ergonomics)
69+
- Performance (speed, latency)
70+
- Format Support (sample rates, channels)
71+
- Integration (Discord, streaming, etc.)
72+
- Documentation
73+
- Other
74+
validations:
75+
required: true
76+
77+
- type: checkboxes
78+
id: implementation
79+
attributes:
80+
label: Implementation Willingness
81+
description: Are you willing to help implement this feature?
82+
options:
83+
- label: I'm willing to submit a pull request for this feature
84+
- label: I can help with testing
85+
- label: I can help with documentation
86+
87+
- type: textarea
88+
id: additional
89+
attributes:
90+
label: Additional Context
91+
description: Add any other context, screenshots, or examples about the feature request
92+
placeholder: Any additional information...

0 commit comments

Comments
 (0)