github-starred/KohakuHub
2
0
Fork 0
mirror of https://github.com/KohakuBlueleaf/KohakuHub.git synced 2026-05-02 18:38:02 -05:00
Code Issues 5 Packages Projects Releases Wiki Activity

update contributing guide

Browse Source
This commit is contained in:
Kohaku-Blueleaf
2025-10-06 21:49:54 +08:00
parent 2fa1452302
commit b5d01595ab
6 changed files with 665 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,112 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the form below with as much detail as possible.
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of the bug
placeholder: Describe what went wrong...
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen
placeholder: Describe the expected behavior...
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened
placeholder: Describe what actually happened...
validations:
required: true
- type: dropdown
id: component
attributes:
label: Component
description: Which component is affected?
options:
- Backend API
- Frontend UI
- CLI Tool
- Documentation
- Docker/Deployment
- LakeFS Integration
- S3/Storage
- Authentication
- Organizations
- Other
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Please provide your environment details
placeholder: |
- OS: [e.g. Ubuntu 22.04, Windows 11, macOS 14]
- Python Version: [e.g. 3.10, 3.11]
- Node.js Version: [e.g. 18.x, 20.x]
- Docker Version: [e.g. 24.0.0]
- Deployment: [e.g. Docker, Local Development]
- Browser (if UI issue): [e.g. Chrome 120, Firefox 121]
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs and Error Messages
description: Relevant logs or error messages
placeholder: |
Paste any relevant logs or error messages here.
Use docker-compose logs -f hub-api for backend logs.
render: shell
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any additional information that might help
placeholder: Screenshots, configuration files, related issues, etc.
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have provided all requested information
required: true
- label: I am using the latest version of KohakuHub
required: false

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Discord Community
url: https://discord.gg/xWYrkyvJ2s
about: Join our Discord server for quick help and discussions
- name: Documentation
url: https://github.com/KohakuBlueleaf/KohakuHub/tree/main/docs
about: Read the documentation for setup guides and API reference

105
.github/ISSUE_TEMPLATE/feature_request.yml vendored Normal file
View File

@@ -0,0 +1,105 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please describe your idea in detail.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve?
placeholder: Describe the problem or limitation you're facing...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How would you like this to work?
placeholder: Describe your proposed solution...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What alternative solutions have you considered?
placeholder: Describe any alternative approaches you've considered...
- type: dropdown
id: component
attributes:
label: Component
description: Which component would this feature affect?
options:
- Backend API
- Frontend UI
- CLI Tool
- Documentation
- Docker/Deployment
- LakeFS Integration
- S3/Storage
- Authentication
- Organizations
- Other
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would improve workflow
- High - Blocking current work
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe your use case for this feature
placeholder: |
Who will benefit from this feature?
How will it be used?
What value does it provide?
validations:
required: true
- type: textarea
id: examples
attributes:
label: Examples
description: Any examples, mockups, or code snippets
placeholder: |
Provide examples of how this feature would work,
including API examples, UI mockups, or code snippets.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any additional information
placeholder: Links to related projects, similar features in other tools, etc.
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have checked the roadmap in CONTRIBUTING.md
required: true
- label: I am willing to help implement this feature
required: false

70
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@@ -0,0 +1,70 @@
name: Question / Help
description: Ask a question or get help
title: "[Question]: "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Have a question? We're here to help!
**Note:** For quick answers, consider joining our [Discord](https://discord.gg/xWYrkyvJ2s)!
- type: textarea
id: question
attributes:
label: Question
description: What would you like to know?
placeholder: Ask your question here...
validations:
required: true
- type: dropdown
id: category
attributes:
label: Category
description: What is your question about?
options:
- Setup / Installation
- Configuration
- API Usage
- CLI Usage
- Frontend Development
- Backend Development
- Deployment
- Authentication / Permissions
- Organizations
- Performance / Optimization
- Troubleshooting
- Other
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Additional context about your question
placeholder: |
What are you trying to accomplish?
What have you tried so far?
Any relevant configuration or setup details?
- type: textarea
id: environment
attributes:
label: Environment (if relevant)
placeholder: |
- OS: [e.g. Ubuntu 22.04]
- Python Version: [e.g. 3.10]
- Deployment: [e.g. Docker, Local]
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have checked the documentation
required: true
- label: I have searched existing issues
required: true