沃巴蒂
ff22ed3a8b
本次同步 09-12 至 09-28 的代码变更，主要内容： 新增功能 - 修改密码：后端新增 ChangePasswordRequest DTO 与UserController/UserService 对应接口，前端新增 ChangePasswordDialog 并在 Header 接入入口 - 文件预览组件重构：file-preview 目录拆分出 VideoPreview（支持 blobUrl 直传）、 ImagePreview、AudioPreview，index.tsx 统一调度各类型预览器 - 新增 my_ops 算子模块：markitdown_parser、mineru_pdf_parser、text_quality_evaluator - 新增 tools/minio-file-server MinIO 文件服务 功能增强 - 数据清洗：cleaning_task_service/scheduler/routes 重构， data_juicer_executor 与 wrapper 增强，OperatorTable/LogsTable/TaskDetail 同步调整 - 数据标注：annotation sync.py、project.py 接口与schema 更新 - 数据采集、算子市场、首页与菜单路由相关页面调整 - DataJuicer 算子接入（useOperatorOperations、dj_ops_schema） 结构调整 - deepflow/ 更名为 deep-flow/（419 个文件重命名） - 新增 helm 部署编排、GitHub Actions 之外的自建镜像构建脚本 未纳入本次提交 - scripts-backup/、runtime/python-executor-backup/、components_backup/（备份目录） - *.backup*、__pycache__ 产物 - zh_core_web_sm-3.8.0-py3-none-any.whl（46MB 构建产物） - DataX/（内嵌独立仓库，远程亦未收录其源码）
145 lines
3.1 KiB
Plaintext
145 lines
3.1 KiB
Plaintext
# Contributing to DeerFlow
|
|
|
|
Thank you for your interest in contributing to DeerFlow! We welcome contributions of all kinds from the community.
|
|
|
|
## Ways to Contribute
|
|
|
|
There are many ways you can contribute to DeerFlow:
|
|
|
|
- **Code Contributions**: Add new features, fix bugs, or improve performance
|
|
- **Documentation**: Improve README, add code comments, or create examples
|
|
- **Bug Reports**: Submit detailed bug reports through issues
|
|
- **Feature Requests**: Suggest new features or improvements
|
|
- **Code Reviews**: Review pull requests from other contributors
|
|
- **Community Support**: Help others in discussions and issues
|
|
|
|
## Development Setup
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork:
|
|
|
|
```bash
|
|
git clone https://github.com/bytedance/deep-flow.git
|
|
cd deep-flow
|
|
```
|
|
|
|
3. Set up your development environment:
|
|
|
|
```bash
|
|
# Install dependencies, uv will take care of the python interpreter and venv creation
|
|
uv sync
|
|
|
|
# For development, install additional dependencies
|
|
uv pip install -e ".[dev]"
|
|
uv pip install -e ".[test]"
|
|
```
|
|
|
|
4. Configure pre-commit hooks:
|
|
|
|
```bash
|
|
chmod +x pre-commit
|
|
ln -s ../../pre-commit .git/hooks/pre-commit
|
|
```
|
|
|
|
## Development Process
|
|
|
|
1. Create a new branch:
|
|
|
|
```bash
|
|
git checkout -b feature/amazing-feature
|
|
```
|
|
|
|
2. Make your changes following our coding standards:
|
|
- Write clear, documented code
|
|
- Follow PEP 8 style guidelines
|
|
- Add tests for new features
|
|
- Update documentation as needed
|
|
|
|
3. Run tests and checks:
|
|
|
|
```bash
|
|
make test # Run tests
|
|
make lint # Run linting
|
|
make format # Format code
|
|
make coverage # Check test coverage
|
|
```
|
|
|
|
4. Commit your changes:
|
|
|
|
```bash
|
|
git commit -m 'Add some amazing feature'
|
|
```
|
|
|
|
5. Push to your fork:
|
|
|
|
```bash
|
|
git push origin feature/amazing-feature
|
|
```
|
|
|
|
6. Open a Pull Request
|
|
|
|
## Pull Request Guidelines
|
|
|
|
- Fill in the pull request template completely
|
|
- Include tests for new features
|
|
- Update documentation as needed
|
|
- Ensure all tests pass and there are no linting errors
|
|
- Keep pull requests focused on a single feature or fix
|
|
- Reference any related issues
|
|
|
|
## Code Style
|
|
|
|
- Follow PEP 8 guidelines
|
|
- Use type hints where possible
|
|
- Write descriptive docstrings
|
|
- Keep functions and methods focused and single-purpose
|
|
- Comment complex logic
|
|
- Python version requirement: >= 3.12
|
|
|
|
## Testing
|
|
|
|
Run the test suite:
|
|
|
|
```bash
|
|
# Run all tests
|
|
make test
|
|
|
|
# Run specific test file
|
|
pytest tests/integration/test_workflow.py
|
|
|
|
# Run with coverage
|
|
make coverage
|
|
```
|
|
|
|
## Code Quality
|
|
|
|
```bash
|
|
# Run linting
|
|
make lint
|
|
|
|
# Format code
|
|
make format
|
|
```
|
|
|
|
## Community Guidelines
|
|
|
|
- Be respectful and inclusive
|
|
- Follow our code of conduct
|
|
- Help others learn and grow
|
|
- Give constructive feedback
|
|
- Stay focused on improving the project
|
|
|
|
## Need Help?
|
|
|
|
If you need help with anything:
|
|
|
|
- Check existing issues and discussions
|
|
- Join our community channels
|
|
- Ask questions in discussions
|
|
|
|
## License
|
|
|
|
By contributing to DeerFlow, you agree that your contributions will be licensed under the MIT License.
|
|
|
|
We appreciate your contributions to making DeerFlow better!
|