Complete Phase 1 foundation: Tasks 1.1 and 1.2
✅ Task 1.1 - Project Foundation Setup: - Repository structure with Python packaging (setup.py, pyproject.toml) - Development dependencies and requirements - Contributing guidelines and MIT license - GitHub workflows for CI/CD (test.yml, release.yml) - Issue and PR templates for community contributions - Comprehensive project documentation ✅ Task 1.2 - Core Client Structure: - wikijs package with proper module organization - Core client class foundation in client.py - Exception hierarchy for error handling - Base model classes and page models - Type checking support (py.typed) - Utility modules and helper functions 📊 Progress: Phase 1 MVP Development now 40% complete 🎯 Next: Task 1.3 - Authentication System implementation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
66
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
66
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,66 @@
|
||||
# Pull Request
|
||||
|
||||
## Description
|
||||
Brief description of what this PR does and why.
|
||||
|
||||
## Type of Change
|
||||
Please delete options that are not relevant.
|
||||
|
||||
- [ ] 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
|
||||
- [ ] Performance improvement
|
||||
- [ ] Code refactoring (no functional changes)
|
||||
- [ ] Test improvements
|
||||
|
||||
## Related Issues
|
||||
Closes #(issue_number)
|
||||
Relates to #(issue_number)
|
||||
|
||||
## Changes Made
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## Testing
|
||||
- [ ] Tests pass locally
|
||||
- [ ] Added tests for new functionality
|
||||
- [ ] Updated existing tests
|
||||
- [ ] Manual testing completed
|
||||
|
||||
Describe any testing you performed:
|
||||
|
||||
## Documentation
|
||||
- [ ] Updated docstrings
|
||||
- [ ] Updated README if needed
|
||||
- [ ] Updated API documentation
|
||||
- [ ] Added/updated examples
|
||||
|
||||
## Code Quality
|
||||
- [ ] Code follows the style guidelines
|
||||
- [ ] Self-review of the code completed
|
||||
- [ ] Code is commented where necessary
|
||||
- [ ] No new warnings introduced
|
||||
|
||||
## Breaking Changes
|
||||
If this introduces breaking changes, please describe them and provide migration guidance:
|
||||
|
||||
## Screenshots/Examples
|
||||
If applicable, add screenshots or code examples to help explain your changes.
|
||||
|
||||
```python
|
||||
# Example usage
|
||||
```
|
||||
|
||||
## Additional Notes
|
||||
Any additional information that reviewers should know.
|
||||
|
||||
---
|
||||
|
||||
## Reviewer Checklist
|
||||
- [ ] Code follows project style guidelines
|
||||
- [ ] Changes are well documented
|
||||
- [ ] Tests are adequate and pass
|
||||
- [ ] No obvious bugs or performance issues
|
||||
- [ ] Breaking changes are properly documented
|
||||
Reference in New Issue
Block a user