Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (85 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

107 lines (85 loc) · 2.71 KB

Contributing to DeepResearch

Thank you for your interest in contributing to DeepResearch! We welcome contributions of all kinds from the community.

What you can contribute

The list below mentions some contributions you can make, but it is not a complete list.:

  • 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
  • Community Support: Help others in discussions and issues

Development Setup

  1. Fork the repository
  2. Clone your fork: 
    git clone git@github.com:<yourname>/DeepResearch.git
cd DeepResearch
  3. Set up your development environment and run the project: 
    # Install Poetry
curl -sSL https://install.python-poetry.org | python3 -
poetry install
poetry env activate
poetry run python -m src.run

Development Process

  1. Create a new branch:

    git checkout -b feature/feature-name   # e.g., feature/text-summarization

  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:

    make format    # Format code
make test      # Run tests
make coverage  # Check test coverage

  4. Commit your changes:

    git commit -m 'Add a new feature'

  5. Push to your fork:

    git push origin feature/feature-name

  6. Submit a pull request for review.

Pull Request Guidelines

  • Fill in the pull request template completely
  • Include tests for new features
  • Update documentation as needed
  • Keep pull requests focused on a single feature or fix
  • Reference any related issues

Code Style

  • Follow PEP 8 guidelines
  • Write descriptive docstrings
  • Keep functions and methods focused and single-purpose
  • Comment complex logic
  • Python version requirement: >= 3.10

Testing

Run the test suite:

# Run all tests
make test

# Run specific test file
pytest src/agent/test_agent.py

# Run with coverage
make coverage

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 DeepResearch, you agree that your contributions will be licensed under the Apache 2.0 License.

We appreciate your contributions to making DeepResearch better!