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
139 changes: 139 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior in Hatchling
title: "[Bug]: "
labels: ["bug", "needs-triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: Please verify these items before submitting
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have checked the [documentation](https://github.com/CrackingShells/Hatchling/tree/main/docs) for relevant information
required: true
- label: I can reproduce this issue consistently
required: true

- type: dropdown
id: bug_category
attributes:
label: Bug Category
description: What type of issue are you experiencing?
options:
- LLM Provider Connection (Ollama/OpenAI authentication, timeouts)
- MCP Server Integration (server connection, tool discovery, execution)
- Chat Interface (CLI display, commands, session management)
- Tool Calling & Chaining (execution failures, citation issues)
- Configuration (settings, environment variables, TOML files)
- Performance (slow responses, memory usage, timeouts)
- Installation & Setup
- Other
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment Information
description: Please provide your system and Hatchling environment details
placeholder: |
- OS: (e.g., Ubuntu 22.04, macOS 14.1, Windows 11)
- Hatchling version: (run `version` command in chat)
- Python version:
- LLM Provider: (Ollama/OpenAI)
- LLM Model: (e.g., llama3.2, gpt-4)
- Docker setup: (yes/no, if using Docker)
render: markdown
validations:
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: Describe what happened and what you expected to happen
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Detailed steps to reproduce the behavior
placeholder: |
1. Start Hatchling with '...'
2. Run command '...'
3. Enter message '...'
4. See error
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: What you expected to happen
placeholder: A clear description of what you expected to happen
validations:
required: true

- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: What actually happened
placeholder: A clear description of what actually happened, including any error messages
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant Logs
description: |
Please include relevant log output. You can:
- Use `show_logs` command in chat to get recent logs
- Check the log file at `~/.hatch/logs/hatchling.log`
- Use `set_log_level debug` for more detailed logging
placeholder: Paste relevant log entries here
render: text

- type: textarea
id: configuration
attributes:
label: Configuration Details
description: |
If the issue is configuration-related, please share relevant settings:
- Settings from `settings:list` command
- Content of `~/.hatch/settings/hatchling_settings.toml` (remove sensitive data like API keys)
- Environment variables (HATCH_*, OLLAMA_*, OPENAI_*)
placeholder: Paste relevant configuration here (remove sensitive information)
render: text

- type: textarea
id: mcp_servers
attributes:
label: MCP Server Information
description: |
If the issue involves MCP servers, please provide:
- Output of `mcp:server:list` command
- Output of `mcp:tool:list` command
- Any custom MCP servers you've added
placeholder: Paste MCP server information here
render: text

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any other context about the problem (screenshots, workarounds tried, etc.)
placeholder: Add any other context about the problem here
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://github.com/CrackingShells/Hatchling/tree/main/docs
about: Check the documentation for setup guides, tutorials, and troubleshooting
- name: 💬 Discussions
url: https://github.com/CrackingShells/Hatchling/discussions
about: Ask questions, share ideas, or discuss features with the community
- name: 🔗 Related Projects
url: https://github.com/CrackingShells
about: Issues with Hatch package manager, schemas, or registry should be reported in their respective repositories
148 changes: 148 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
name: 📚 Documentation Issue
description: Report issues with documentation or request documentation improvements
title: "[Docs]: "
labels: ["documentation", "needs-triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation! Please provide details about the documentation issue or improvement.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: Please verify these items before submitting
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have checked multiple documentation sources (README, docs/, articles/)
required: true

- type: dropdown
id: doc_type
attributes:
label: Documentation Type
description: What type of documentation issue is this?
options:
- Missing Documentation (feature/command not documented)
- Incorrect Information (documentation is wrong or outdated)
- Unclear Instructions (confusing or hard to follow)
- Broken Links (links don't work or go to wrong place)
- Typos/Grammar (spelling, grammar, or formatting issues)
- Missing Examples (need more examples or use cases)
- Installation/Setup (issues with setup instructions)
- API/Command Reference (missing or incorrect command documentation)
- Other
validations:
required: true

- type: input
id: doc_location
attributes:
label: Documentation Location
description: Where is the documentation issue located?
placeholder: |
e.g., README.md, docs/articles/users/chat_commands.md,
docs/articles/users/tutorials/Installation/docker-ollama-setup.md
validations:
required: true

- type: textarea
id: issue_description
attributes:
label: Issue Description
description: Describe the documentation issue in detail
placeholder: |
Clearly describe what's wrong, missing, or confusing about the documentation.
Be specific about what you were trying to accomplish.
validations:
required: true

- type: textarea
id: current_content
attributes:
label: Current Content
description: |
If applicable, quote the current documentation content that has issues
placeholder: |
Copy and paste the current documentation text that needs to be fixed.
Use quotes or code blocks to clearly identify the content.
render: markdown

- type: textarea
id: suggested_improvement
attributes:
label: Suggested Improvement
description: How should the documentation be improved?
placeholder: |
Provide your suggestion for how to fix or improve the documentation.
Include specific text changes, additional examples, or structural improvements.
validations:
required: true

- type: textarea
id: context
attributes:
label: Context
description: What were you trying to accomplish when you found this issue?
placeholder: |
Describe your use case or what you were trying to learn/do:
- Setting up Hatchling for the first time
- Trying to use a specific command
- Integrating with a new LLM provider
- Creating a custom MCP server
- etc.
validations:
required: true

- type: dropdown
id: user_level
attributes:
label: User Experience Level
description: What's your experience level with Hatchling?
options:
- New User (first time using Hatchling)
- Beginner (basic usage, following tutorials)
- Intermediate (comfortable with most features)
- Advanced (power user, custom configurations)
- Developer (contributing to the project)
validations:
required: true

- type: textarea
id: additional_examples
attributes:
label: Additional Examples Needed
description: |
If requesting examples, what specific scenarios should be covered?
placeholder: |
Describe what examples would be helpful:
- Step-by-step tutorials
- Common use cases
- Configuration examples
- Troubleshooting scenarios
- Code samples

- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Would you be interested in helping improve this documentation?
options:
- label: I would be willing to contribute to fixing this documentation
- label: I would be willing to review proposed documentation changes
- label: I can provide additional examples or use cases

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any other context about this documentation issue
placeholder: |
Include any additional information:
- Screenshots of confusing interfaces
- Links to related documentation
- Similar issues in other projects
- Urgency or impact of this issue
Loading