KohakuHub/.github/pull_request_template.md

Pull Request

Description

Type of Change

• 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

• Backend API
• Frontend UI
• CLI Tool
• Documentation
• Docker/Deployment
• Database
• Authentication
• LakeFS Integration
• S3/Storage

Related Issues

• Fixes #
• Related to #

Changes Made

Testing

Test Environment

• Local development setup
• Docker deployment
• Both

Test Scenarios

• 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 relevant test output here

Screenshots / Videos

Before

After

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

• This PR includes breaking changes

Migration Guide

Deployment Notes

• No special deployment steps required
• Database migration required
• Environment variables changed
• Docker image rebuild required
• Configuration file updates needed

Deployment Steps

Checklist

Pre-submission

• I have read the 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

Reviewer Notes

---

For Maintainers:

• Code review completed
• Tests pass
• Documentation is adequate
• Ready to merge