deer-flow/CONTRIBUTING at main · ModelEngine-Group/deer-flow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# 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/deer-flow.git
   cd deer-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!