mirror of
https://github.com/KohakuBlueleaf/KohakuHub.git
synced 2026-04-29 10:58:32 -05:00
164 lines
3.9 KiB
Markdown
164 lines
3.9 KiB
Markdown
# Pull Request
|
|
|
|
## Description
|
|
|
|
<!-- Provide a clear and concise description of your changes -->
|
|
|
|
## Type of Change
|
|
|
|
<!-- Mark the relevant option with an "x" -->
|
|
|
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
|
- [ ] New feature (non-breaking change which adds functionality)
|
|
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
- [ ] Documentation update
|
|
- [ ] Code refactoring
|
|
- [ ] Performance improvement
|
|
- [ ] Test coverage improvement
|
|
- [ ] Build/CI improvement
|
|
|
|
## Component
|
|
|
|
<!-- Mark all that apply -->
|
|
|
|
- [ ] Backend API
|
|
- [ ] Frontend UI
|
|
- [ ] CLI Tool
|
|
- [ ] Documentation
|
|
- [ ] Docker/Deployment
|
|
- [ ] Database
|
|
- [ ] Authentication
|
|
- [ ] LakeFS Integration
|
|
- [ ] S3/Storage
|
|
|
|
## Related Issues
|
|
|
|
<!-- Link any related issues. Use "Fixes #issue_number" or "Closes #issue_number" for automatic closing -->
|
|
|
|
- Fixes #
|
|
- Related to #
|
|
|
|
## Changes Made
|
|
|
|
<!-- List the main changes made in this PR -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
## Testing
|
|
|
|
<!-- Describe the tests you ran and how to reproduce them -->
|
|
|
|
### Test Environment
|
|
- [ ] Local development setup
|
|
- [ ] Docker deployment
|
|
- [ ] Both
|
|
|
|
### Test Scenarios
|
|
<!-- Describe what you tested -->
|
|
|
|
- [ ] Unit tests added/updated
|
|
- [ ] Integration tests added/updated
|
|
- [ ] Manual testing performed
|
|
- [ ] Tested in both light and dark mode (for UI changes)
|
|
- [ ] Tested on mobile viewport (for UI changes)
|
|
|
|
### Test Results
|
|
<!-- Paste test output or describe test results -->
|
|
|
|
```
|
|
# Paste relevant test output here
|
|
```
|
|
|
|
## Screenshots / Videos
|
|
|
|
<!-- If applicable, add screenshots or videos to demonstrate changes -->
|
|
|
|
### Before
|
|
<!-- Screenshots of the old behavior -->
|
|
|
|
### After
|
|
<!-- Screenshots of the new behavior -->
|
|
|
|
## Documentation
|
|
|
|
- [ ] Code is self-documenting and follows project conventions
|
|
- [ ] Docstrings/comments added for complex logic
|
|
- [ ] README.md updated (if needed)
|
|
- [ ] API.md updated (if API changes)
|
|
- [ ] CLI.md updated (if CLI changes)
|
|
- [ ] CONTRIBUTING.md updated (if workflow changes)
|
|
|
|
## Breaking Changes
|
|
|
|
<!-- If this PR introduces breaking changes, describe them and the migration path -->
|
|
|
|
- [ ] This PR includes breaking changes
|
|
|
|
### Migration Guide
|
|
<!-- Provide instructions for users to migrate from the old behavior to the new -->
|
|
|
|
## Deployment Notes
|
|
|
|
<!-- Any special deployment steps or configuration changes needed? -->
|
|
|
|
- [ ] No special deployment steps required
|
|
- [ ] Database migration required
|
|
- [ ] Environment variables changed
|
|
- [ ] Docker image rebuild required
|
|
- [ ] Configuration file updates needed
|
|
|
|
### Deployment Steps
|
|
<!-- If special steps are required, list them here -->
|
|
|
|
1.
|
|
2.
|
|
|
|
## Checklist
|
|
|
|
<!-- Final checks before submission -->
|
|
|
|
### Pre-submission
|
|
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
|
|
- [ ] My code follows the project's coding standards
|
|
- [ ] I have searched existing issues/PRs to avoid duplicates
|
|
|
|
### Testing
|
|
- [ ] I have tested my changes thoroughly
|
|
- [ ] I have added/updated tests as necessary
|
|
- [ ] All existing tests pass
|
|
- [ ] Tested in both development and Docker deployment modes
|
|
- [ ] For UI changes: Tested in both light and dark mode
|
|
- [ ] For UI changes: Tested on mobile viewport
|
|
|
|
### Documentation
|
|
- [ ] I have updated documentation as necessary
|
|
- [ ] Code is self-documenting with clear variable/function names
|
|
- [ ] Complex logic has explanatory comments
|
|
- [ ] API changes documented in API.md (if applicable)
|
|
- [ ] CLI changes documented in CLI.md (if applicable)
|
|
|
|
### Quality
|
|
- [ ] My changes generate no new warnings or errors
|
|
- [ ] I have checked my code for security issues
|
|
- [ ] No hardcoded credentials or sensitive data
|
|
- [ ] I have added myself to CONTRIBUTORS.md (if first contribution)
|
|
|
|
## Additional Notes
|
|
|
|
<!-- Any additional information reviewers should know -->
|
|
|
|
## Reviewer Notes
|
|
|
|
<!-- Optional: Specific areas you'd like reviewers to focus on -->
|
|
|
|
---
|
|
|
|
**For Maintainers:**
|
|
|
|
- [ ] Code review completed
|
|
- [ ] Tests pass
|
|
- [ ] Documentation is adequate
|
|
- [ ] Ready to merge
|