Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.47 KB
Raw

Contributing to phi-agent

Thanks for your interest in contributing! This guide gets you from clone to PR in minutes.

Quick Start (5 min)

git clone https://github.com/hibuka-labs/phi-agent.git
cd phi-agent
cargo build        # pulls dependencies from crates.io automatically
cargo test         # make sure everything passes

That's it. phi-agent uses pure crates.io dependencies — cargo build downloads everything you need. You don't need to clone any other repository for most contributions.

Finding Something to Work On

  • Good First Issues — small, well-scoped tasks ideal for new contributors. Each one explains what to change and how to verify it.
  • Help Wanted — larger features or improvements the maintainers would love help with.
  • Got your own idea? Open an issue first to discuss it before writing code — saves you time if it doesn't fit the roadmap.

Before Submitting a PR

cargo fmt --check    # Formatting
cargo clippy --all-targets -- -D warnings   # Linting
cargo test           # Tests

All three must pass. CI runs them automatically on every PR, so save yourself a round-trip.

Pull Request Checklist

  1. Create a feature branch from master
  2. Make your changes, with tests if applicable
  3. Run the checks above (fmt, clippy, test)
  4. Add an entry to CHANGELOG.md under [Unreleased]
  5. Open a PR with a clear description of what and why

Review Timeline

We review PRs within 48 hours. Small, focused PRs (one logical change) get merged faster. If your PR is large, consider breaking it up.

Commit Style

  • Present tense, imperative mood: "add feature" not "added feature"
  • One logical change per commit
  • Reference issues with #123 when applicable

Advanced: Working Across Crates

If your change requires modifying a sibling crate (agent-base, agent-works, etc.) simultaneously:

# Clone the dependency alongside phi-agent
cd ..
git clone https://github.com/hibuka-labs/agent-base.git
cd phi-agent

# Temporarily add a path override in Cargo.toml (DO NOT COMMIT):
# agent-base = { version = "0.1.11", path = "../agent-base" }

Remove the path override before committing. See CLAUDE.md for details on the multi-repo workflow.

Questions?

Open a GitHub Discussion or an issue.