Contributing to Dapr agents

When contributing to Dapr agents, the following rules and best-practices should be followed.

Examples

The examples directory contains code samples for users to run to try out specific functionality of the various Dapr agents packages and extensions. When writing new and updated samples keep in mind:

• All examples should be runnable on Windows, Linux, and MacOS. While Python code is consistent among operating systems, any pre/post example commands should provide options through codetabs
• Contain steps to download/install any required pre-requisites. Someone coming in with a fresh OS install should be able to start on the example and complete it without an error. Links to external download pages are fine.

Dependencies

This project uses modern Python packaging with pyproject.toml. Dependencies are managed as follows:

• Main dependencies are in [project.dependencies]
• Test dependencies are in [project.optional-dependencies.test]
• Development dependencies are in [project.optional-dependencies.dev]

Generating Requirements Files

If you need to generate requirements files (e.g., for deployment or specific environments):

# Generate requirements.txt
pip-compile pyproject.toml

# Generate dev-requirements.txt
pip-compile pyproject.toml --extra dev

Installing Dependencies

# Install main package with test dependencies
pip install -e ".[test]"

# Install main package with development dependencies
pip install -e ".[dev]"

# Install main package with all optional dependencies
pip install -e ".[test,dev]"

Testing

The project uses pytest for testing. To run tests:

# Run all tests
tox -e pytest

# Run specific test file
tox -e pytest tests/test_random_orchestrator.py

# Run tests with coverage
tox -e pytest --cov=dapr_agents

Code Quality

The project uses several tools to maintain code quality:

# Run linting
tox -e flake8

# Run code formatting
tox -e ruff

# Run type checking
tox -e type

Development Workflow

1. Install development dependencies:

   pip install -e ".[dev]"
   

2. Run tests before making changes:

   tox -e pytest
   

3. Make your changes

4. Run code quality checks:

   tox -e flake8
   tox -e ruff
   tox -e type
   

5. Run tests again:

   tox -e pytest
   

6. Submit your changes

GitHub Dapr Bot Commands

Checkout the daprbot documentation for GitHub commands you can run in this repo for common tasks. For example, you can run the /assign (as a comment on an issue) to assign issues to a user or group of users.

Feedback

Was this page helpful?