mirror of
https://github.com/KohakuBlueleaf/KohakuHub.git
synced 2026-04-30 09:28:35 -05:00
update pr template
This commit is contained in:
55
.github/pull_request_template.md
vendored
55
.github/pull_request_template.md
vendored
@@ -91,18 +91,6 @@
|
|||||||
- [ ] CLI.md updated (if CLI changes)
|
- [ ] CLI.md updated (if CLI changes)
|
||||||
- [ ] CONTRIBUTING.md updated (if workflow changes)
|
- [ ] CONTRIBUTING.md updated (if workflow changes)
|
||||||
|
|
||||||
## Code Quality
|
|
||||||
|
|
||||||
- [ ] Code follows the style guidelines (see [CLAUDE.md](../CLAUDE.md))
|
|
||||||
- [ ] Python code formatted with `black`
|
|
||||||
- [ ] Frontend code formatted with `prettier`
|
|
||||||
- [ ] Used `db_async` wrappers for all database operations
|
|
||||||
- [ ] Permission checks added for write operations
|
|
||||||
- [ ] Error handling follows HuggingFace-compatible format
|
|
||||||
- [ ] Import order follows convention (builtin → 3rd party → ours)
|
|
||||||
- [ ] No debug code or commented-out code left in
|
|
||||||
- [ ] Type hints added (Python) or JSDoc comments (JavaScript)
|
|
||||||
|
|
||||||
## Breaking Changes
|
## Breaking Changes
|
||||||
|
|
||||||
<!-- If this PR introduces breaking changes, describe them and the migration path -->
|
<!-- If this PR introduces breaking changes, describe them and the migration path -->
|
||||||
@@ -112,27 +100,6 @@
|
|||||||
### Migration Guide
|
### Migration Guide
|
||||||
<!-- Provide instructions for users to migrate from the old behavior to the new -->
|
<!-- Provide instructions for users to migrate from the old behavior to the new -->
|
||||||
|
|
||||||
## Security Considerations
|
|
||||||
|
|
||||||
<!-- Mark if applicable -->
|
|
||||||
|
|
||||||
- [ ] This PR introduces security-sensitive changes
|
|
||||||
- [ ] Authentication/authorization logic changed
|
|
||||||
- [ ] Input validation added/updated
|
|
||||||
- [ ] SQL injection prevention verified
|
|
||||||
- [ ] XSS prevention verified
|
|
||||||
|
|
||||||
## Performance Impact
|
|
||||||
|
|
||||||
<!-- Describe any performance implications -->
|
|
||||||
|
|
||||||
- [ ] No performance impact
|
|
||||||
- [ ] Performance improved
|
|
||||||
- [ ] Performance may be impacted (explain below)
|
|
||||||
|
|
||||||
### Performance Details
|
|
||||||
<!-- Describe performance testing or considerations -->
|
|
||||||
|
|
||||||
## Deployment Notes
|
## Deployment Notes
|
||||||
|
|
||||||
<!-- Any special deployment steps or configuration changes needed? -->
|
<!-- Any special deployment steps or configuration changes needed? -->
|
||||||
@@ -153,16 +120,32 @@
|
|||||||
|
|
||||||
<!-- Final checks before submission -->
|
<!-- Final checks before submission -->
|
||||||
|
|
||||||
|
### Pre-submission
|
||||||
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
|
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
|
||||||
- [ ] I have read the [CLAUDE.md](../CLAUDE.md) developer guide
|
- [ ] I have read the [CLAUDE.md](../CLAUDE.md) developer guide
|
||||||
- [ ] My code follows the project's coding standards
|
- [ ] 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 tested my changes thoroughly
|
||||||
- [ ] I have added/updated tests as necessary
|
- [ ] I have added/updated tests as necessary
|
||||||
- [ ] I have updated documentation as necessary
|
|
||||||
- [ ] My changes generate no new warnings or errors
|
|
||||||
- [ ] All existing tests pass
|
- [ ] 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
|
- [ ] I have checked my code for security issues
|
||||||
- [ ] I have added myself to CONTRIBUTORS.md (if applicable)
|
- [ ] No hardcoded credentials or sensitive data
|
||||||
|
- [ ] I have added myself to CONTRIBUTORS.md (if first contribution)
|
||||||
|
|
||||||
## Additional Notes
|
## Additional Notes
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user