Skip to content

Commit 5e59d61

Browse files
author
LittleCoinCoin
committed
chore(issues): add GitHub issue templates
Add YAML templates under .github/ISSUE_TEMPLATE for bug reports, feature requests, LLM provider issues, MCP/server issues and documentation. Templates capture project-specific details (LLM provider/model info, MCP payloads, Docker/.env context, and test logs) to improve triage and reproducibility.
1 parent e967e21 commit 5e59d61

File tree

6 files changed

+783
-0
lines changed

6 files changed

+783
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in Hatchling
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: Pre-submission checklist
16+
description: Please verify these items before submitting
17+
options:
18+
- label: I have searched existing issues to ensure this is not a duplicate
19+
required: true
20+
- label: I have checked the [documentation](https://github.com/CrackingShells/Hatchling/tree/main/docs) for relevant information
21+
required: true
22+
- label: I can reproduce this issue consistently
23+
required: true
24+
25+
- type: dropdown
26+
id: bug_category
27+
attributes:
28+
label: Bug Category
29+
description: What type of issue are you experiencing?
30+
options:
31+
- LLM Provider Connection (Ollama/OpenAI authentication, timeouts)
32+
- MCP Server Integration (server connection, tool discovery, execution)
33+
- Chat Interface (CLI display, commands, session management)
34+
- Tool Calling & Chaining (execution failures, citation issues)
35+
- Configuration (settings, environment variables, TOML files)
36+
- Performance (slow responses, memory usage, timeouts)
37+
- Installation & Setup
38+
- Other
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: environment
44+
attributes:
45+
label: Environment Information
46+
description: Please provide your system and Hatchling environment details
47+
placeholder: |
48+
- OS: (e.g., Ubuntu 22.04, macOS 14.1, Windows 11)
49+
- Hatchling version: (run `version` command in chat)
50+
- Python version:
51+
- LLM Provider: (Ollama/OpenAI)
52+
- LLM Model: (e.g., llama3.2, gpt-4)
53+
- Docker setup: (yes/no, if using Docker)
54+
render: markdown
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: description
60+
attributes:
61+
label: Bug Description
62+
description: A clear and concise description of what the bug is
63+
placeholder: Describe what happened and what you expected to happen
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: reproduction
69+
attributes:
70+
label: Steps to Reproduce
71+
description: Detailed steps to reproduce the behavior
72+
placeholder: |
73+
1. Start Hatchling with '...'
74+
2. Run command '...'
75+
3. Enter message '...'
76+
4. See error
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: expected_behavior
82+
attributes:
83+
label: Expected Behavior
84+
description: What you expected to happen
85+
placeholder: A clear description of what you expected to happen
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: actual_behavior
91+
attributes:
92+
label: Actual Behavior
93+
description: What actually happened
94+
placeholder: A clear description of what actually happened, including any error messages
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
id: logs
100+
attributes:
101+
label: Relevant Logs
102+
description: |
103+
Please include relevant log output. You can:
104+
- Use `show_logs` command in chat to get recent logs
105+
- Check the log file at `~/.hatch/logs/hatchling.log`
106+
- Use `set_log_level debug` for more detailed logging
107+
placeholder: Paste relevant log entries here
108+
render: text
109+
110+
- type: textarea
111+
id: configuration
112+
attributes:
113+
label: Configuration Details
114+
description: |
115+
If the issue is configuration-related, please share relevant settings:
116+
- Settings from `settings:list` command
117+
- Content of `~/.hatch/settings/hatchling_settings.toml` (remove sensitive data like API keys)
118+
- Environment variables (HATCH_*, OLLAMA_*, OPENAI_*)
119+
placeholder: Paste relevant configuration here (remove sensitive information)
120+
render: text
121+
122+
- type: textarea
123+
id: mcp_servers
124+
attributes:
125+
label: MCP Server Information
126+
description: |
127+
If the issue involves MCP servers, please provide:
128+
- Output of `mcp:server:list` command
129+
- Output of `mcp:tool:list` command
130+
- Any custom MCP servers you've added
131+
placeholder: Paste MCP server information here
132+
render: text
133+
134+
- type: textarea
135+
id: additional_context
136+
attributes:
137+
label: Additional Context
138+
description: Any other context about the problem (screenshots, workarounds tried, etc.)
139+
placeholder: Add any other context about the problem here

‎.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: 📚 Documentation
4+
url: https://github.com/CrackingShells/Hatchling/tree/main/docs
5+
about: Check the documentation for setup guides, tutorials, and troubleshooting
6+
- name: 💬 Discussions
7+
url: https://github.com/CrackingShells/Hatchling/discussions
8+
about: Ask questions, share ideas, or discuss features with the community
9+
- name: 🔗 Related Projects
10+
url: https://github.com/CrackingShells
11+
about: Issues with Hatch package manager, schemas, or registry should be reported in their respective repositories

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
name: 📚 Documentation Issue
2+
description: Report issues with documentation or request documentation improvements
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping improve our documentation! Please provide details about the documentation issue or improvement.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: Pre-submission checklist
16+
description: Please verify these items before submitting
17+
options:
18+
- label: I have searched existing issues to ensure this is not a duplicate
19+
required: true
20+
- label: I have checked multiple documentation sources (README, docs/, articles/)
21+
required: true
22+
23+
- type: dropdown
24+
id: doc_type
25+
attributes:
26+
label: Documentation Type
27+
description: What type of documentation issue is this?
28+
options:
29+
- Missing Documentation (feature/command not documented)
30+
- Incorrect Information (documentation is wrong or outdated)
31+
- Unclear Instructions (confusing or hard to follow)
32+
- Broken Links (links don't work or go to wrong place)
33+
- Typos/Grammar (spelling, grammar, or formatting issues)
34+
- Missing Examples (need more examples or use cases)
35+
- Installation/Setup (issues with setup instructions)
36+
- API/Command Reference (missing or incorrect command documentation)
37+
- Other
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: doc_location
43+
attributes:
44+
label: Documentation Location
45+
description: Where is the documentation issue located?
46+
placeholder: |
47+
e.g., README.md, docs/articles/users/chat_commands.md,
48+
docs/articles/users/tutorials/Installation/docker-ollama-setup.md
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: issue_description
54+
attributes:
55+
label: Issue Description
56+
description: Describe the documentation issue in detail
57+
placeholder: |
58+
Clearly describe what's wrong, missing, or confusing about the documentation.
59+
Be specific about what you were trying to accomplish.
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: current_content
65+
attributes:
66+
label: Current Content
67+
description: |
68+
If applicable, quote the current documentation content that has issues
69+
placeholder: |
70+
Copy and paste the current documentation text that needs to be fixed.
71+
Use quotes or code blocks to clearly identify the content.
72+
render: markdown
73+
74+
- type: textarea
75+
id: suggested_improvement
76+
attributes:
77+
label: Suggested Improvement
78+
description: How should the documentation be improved?
79+
placeholder: |
80+
Provide your suggestion for how to fix or improve the documentation.
81+
Include specific text changes, additional examples, or structural improvements.
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
id: context
87+
attributes:
88+
label: Context
89+
description: What were you trying to accomplish when you found this issue?
90+
placeholder: |
91+
Describe your use case or what you were trying to learn/do:
92+
- Setting up Hatchling for the first time
93+
- Trying to use a specific command
94+
- Integrating with a new LLM provider
95+
- Creating a custom MCP server
96+
- etc.
97+
validations:
98+
required: true
99+
100+
- type: dropdown
101+
id: user_level
102+
attributes:
103+
label: User Experience Level
104+
description: What's your experience level with Hatchling?
105+
options:
106+
- New User (first time using Hatchling)
107+
- Beginner (basic usage, following tutorials)
108+
- Intermediate (comfortable with most features)
109+
- Advanced (power user, custom configurations)
110+
- Developer (contributing to the project)
111+
validations:
112+
required: true
113+
114+
- type: textarea
115+
id: additional_examples
116+
attributes:
117+
label: Additional Examples Needed
118+
description: |
119+
If requesting examples, what specific scenarios should be covered?
120+
placeholder: |
121+
Describe what examples would be helpful:
122+
- Step-by-step tutorials
123+
- Common use cases
124+
- Configuration examples
125+
- Troubleshooting scenarios
126+
- Code samples
127+
128+
- type: checkboxes
129+
id: contribution
130+
attributes:
131+
label: Contribution
132+
description: Would you be interested in helping improve this documentation?
133+
options:
134+
- label: I would be willing to contribute to fixing this documentation
135+
- label: I would be willing to review proposed documentation changes
136+
- label: I can provide additional examples or use cases
137+
138+
- type: textarea
139+
id: additional_context
140+
attributes:
141+
label: Additional Context
142+
description: Any other context about this documentation issue
143+
placeholder: |
144+
Include any additional information:
145+
- Screenshots of confusing interfaces
146+
- Links to related documentation
147+
- Similar issues in other projects
148+
- Urgency or impact of this issue

0 commit comments

Comments
 (0)