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
187 changes: 187 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior in Hatch package manager
title: "[Bug]: "
labels: ["bug", "needs-triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please follow the [troubleshooting guide](https://github.com/CrackingShells/Hatch/blob/main/docs/articles/users/Troubleshooting/ReportIssues.md) to collect diagnostic information before submitting.

- 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 followed the [troubleshooting guide](https://github.com/CrackingShells/Hatch/blob/main/docs/articles/users/Troubleshooting/ReportIssues.md) and collected diagnostic 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:
- Package Management (installation, removal, dependency resolution)
- Environment Management (creation, removal, switching environments)
- Registry Issues (connectivity, package discovery, cache problems)
- CLI Issues (command parsing, argument validation, output formatting)
- Template Generation (package creation, metadata generation)
- Installation Issues (Python, system, Docker, Hatch package installers)
- Performance Issues (slow operations, memory usage, large environments)
- Validation Issues (package validation, schema problems)
- Other
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment Information
description: Please provide your system environment details
placeholder: |
- OS: (e.g., Ubuntu 22.04, macOS 14.1, Windows 11)
- Hatch version: (run `pip show hatch`)
- Python version:
- Package manager: (conda/mamba version if applicable)
- Current environment: (run `hatch env current`)
render: markdown
validations:
required: true

- type: textarea
id: command_run
attributes:
label: Command Executed
description: What exact command did you run?
placeholder: |
Paste the exact command that caused the issue:
hatch package add my-package --env my-env
render: shell
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. Create environment with 'hatch env create test-env'
2. Run command 'hatch package add ...'
3. 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, including the complete error output
placeholder: |
Paste the complete error output here.
Include the full command output and any error messages.
render: text
validations:
required: true

- type: textarea
id: diagnostics
attributes:
label: Diagnostic Information
description: |
Please run the diagnostic commands from the troubleshooting guide and paste the output:
placeholder: |
Run these commands and paste the output:

hatch env list
hatch env current
hatch package list
pip show hatch

For environment-specific issues:
hatch env python info --hatch_env <env-name> --detailed

For registry issues:
hatch package add <package-name> --refresh-registry

Cache information:
ls -la ~/.hatch/cache/packages (Linux/macOS)
Get-ChildItem -Path $env:USERPROFILE\.hatch\cache (Windows PowerShell)
render: text
validations:
required: true

- type: textarea
id: package_info
attributes:
label: Package Information
description: |
If the issue involves a specific package, provide package details:
placeholder: |
- Package name and version:
- Package source: (local path, registry, URL)
- Package metadata: (content of hatch_metadata.json if relevant)
- Dependencies: (if dependency-related issue)
render: text

- type: textarea
id: logs
attributes:
label: Log Files
description: |
Please attach or paste relevant log files. For large logs, attach as files rather than pasting.
placeholder: |
Include any relevant log files:
- Command output with full error messages
- Installation logs
- Environment creation logs
render: text

- type: textarea
id: workarounds
attributes:
label: Workarounds Tried
description: What have you tried to resolve this issue?
placeholder: |
List any workarounds or troubleshooting steps you've tried:
- Clearing cache
- Recreating environment
- Using different package versions
- etc.

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any other context about the problem
placeholder: |
Include any additional information that might be helpful:
- Network connectivity issues
- Disk space constraints
- Custom configurations
- Related issues or patterns
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://crackingshells.github.io/Hatch/
about: Check the official documentation for guides, tutorials, and API reference
- name: 💬 Discussions
url: https://github.com/CrackingShells/Hatch/discussions
about: Ask questions, share ideas, or discuss features with the community
- name: 🔗 Related Projects
url: https://github.com/CrackingShells
about: Issues with Hatchling, schemas, validator, or registry should be reported in their respective repositories
- name: 🛠️ Troubleshooting Guide
url: https://github.com/CrackingShells/Hatch/blob/main/docs/articles/users/Troubleshooting/ReportIssues.md
about: Follow the troubleshooting guide to collect diagnostic information before reporting issues
171 changes: 171 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
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/, website)
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)
- CLI Reference (missing or incorrect command documentation)
- API Documentation (missing or incorrect API docs)
- Architecture/Design (missing technical 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/CLIReference.md,
docs/articles/users/GettingStarted.md, https://crackingshells.github.io/Hatch/
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:
- Installing Hatch for the first time
- Creating a new package
- Managing environments
- Understanding CLI commands
- Setting up CI/CD integration
- etc.
validations:
required: true

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

- type: dropdown
id: doc_section
attributes:
label: Documentation Section
description: Which section of documentation needs improvement?
options:
- Getting Started / Installation
- CLI Reference / Commands
- Package Management
- Environment Management
- Template Generation
- Troubleshooting
- Developer / Contribution Guides
- Architecture / Technical Design
- API Reference
- Examples / Tutorials
- Other

- 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 for common workflows
- CLI command examples with real use cases
- Package creation and management examples
- Environment setup scenarios
- Integration examples (CI/CD, Docker, etc.)
- Troubleshooting scenarios

- 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
- Audience this documentation should target
Loading