Contributing to Osprey#

Thank you for your interest in contributing to the Osprey Framework. This guide covers environment setup, Git workflow, code standards, the agent skills that automate them, and community guidelines.


Development Setup

Fork, install with uv, wire up pre-commit — and the Python, front-end, and testing standards your change is held to.

Development Setup
Git and GitHub Workflow

Branch naming, the local check tiers, conventional commits, and what happens to your pull request on the way to main.

Git and GitHub Workflow
Extending Osprey

The seam map: connector, archiver, MCP server, chat bridge, ARIEL, health plugin, panel, LUME model – each with the class or registry to subclass, a pinning test, and the how-to that configures it.

Extending Osprey
Agent Skills

One plugin, osprey, carrying twelve skills that teach a coding agent Osprey’s own playbooks. How to install it, what each /osprey:<name> skill does, and where the deployer-facing ones are documented.

Agent Skills

Community Guidelines#

Code of Conduct: We are committed to a welcoming and inclusive environment.

  • Be respectful, welcome newcomers, accept constructive criticism, and show empathy.

  • Harassment, personal attacks, trolling, or publishing private information are unacceptable.

  • Report issues to the maintainers; all reports are handled confidentially.

Communication Channels:

  • GitHub Issues – Bug reports, feature requests, task tracking

  • GitHub Discussions – Questions, ideas, brainstorming

  • Pull Requests – Code contributions, documentation, code review

Reporting Bugs: Search existing issues first, then open a bug report with a clear description, reproduction steps, environment details (OS, Python version, Osprey version), and full error messages.

Feature Requests: Describe your use case, current limitations, proposed solution, and alternatives considered.

Response Expectations: Maintainers are volunteers. Please be patient and provide clear, detailed information.

Getting Help#