|
| 1 | +# Contributing to databricks-agents |
| 2 | + |
| 3 | +Thank you for your interest in contributing to databricks-agents! This project is a Databricks Labs initiative to make it easier to build discoverable AI agents on Databricks Apps. |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +1. Clone the repository |
| 8 | +2. Install dependencies: |
| 9 | + ```bash |
| 10 | + pip install -e ".[dev]" |
| 11 | + ``` |
| 12 | +3. Run tests: |
| 13 | + ```bash |
| 14 | + pytest |
| 15 | + ``` |
| 16 | + |
| 17 | +## Code Style |
| 18 | + |
| 19 | +- Use Black for code formatting: `black src/` |
| 20 | +- Use Ruff for linting: `ruff check src/` |
| 21 | +- Line length: 100 characters (configured in `pyproject.toml`) |
| 22 | +- Type hints are encouraged for public APIs |
| 23 | + |
| 24 | +## Testing |
| 25 | + |
| 26 | +- Write tests for new features using pytest |
| 27 | +- Place tests in the `tests/` directory |
| 28 | +- Run tests with: `pytest tests/` |
| 29 | +- Aim for >80% code coverage |
| 30 | + |
| 31 | +## Pull Requests |
| 32 | + |
| 33 | +1. Fork the repository |
| 34 | +2. Create a feature branch: `git checkout -b feature/my-feature` |
| 35 | +3. Make your changes |
| 36 | +4. Add tests for new functionality |
| 37 | +5. Run tests and linting: `pytest && black src/ && ruff check src/` |
| 38 | +6. Commit with a clear message describing the change |
| 39 | +7. Push and create a pull request |
| 40 | + |
| 41 | +## PR Guidelines |
| 42 | + |
| 43 | +- **Clear description**: Explain what the PR does and why |
| 44 | +- **Tests included**: All new features should have tests |
| 45 | +- **Documentation updated**: Update README.md and docstrings as needed |
| 46 | +- **Small, focused changes**: One feature or fix per PR |
| 47 | +- **Passes CI**: All tests and linting must pass |
| 48 | + |
| 49 | +## Areas for Contribution |
| 50 | + |
| 51 | +We welcome contributions in these areas: |
| 52 | + |
| 53 | +- **Unity Catalog integration**: Register agents as UC catalog objects |
| 54 | +- **MCP server support**: Add Model Context Protocol server capabilities |
| 55 | +- **Orchestration patterns**: Multi-agent coordination utilities |
| 56 | +- **RAG utilities**: Built-in vector search and retrieval patterns |
| 57 | +- **Observability**: Logging, metrics, and tracing integrations |
| 58 | +- **Documentation**: Examples, guides, and API documentation |
| 59 | +- **Testing**: Improve test coverage and test utilities |
| 60 | + |
| 61 | +## Questions? |
| 62 | + |
| 63 | +- Open an issue for bugs or feature requests |
| 64 | +- Start a discussion for design questions |
| 65 | +- Check existing issues and PRs before starting work |
| 66 | + |
| 67 | +## Code of Conduct |
| 68 | + |
| 69 | +Be respectful, inclusive, and constructive in all interactions. This is a professional community focused on building great tools together. |
| 70 | + |
| 71 | +## License |
| 72 | + |
| 73 | +By contributing, you agree that your contributions will be licensed under the Apache 2.0 License. |
0 commit comments