Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (63 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

92 lines (63 loc) · 2.26 KB

Contributing to AgenticVeritas

Thank you for your interest in contributing to AgenticVeritas! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/agentic-veritas.git
  3. Create a feature branch: git checkout -b my-feature
  4. Make your changes
  5. Run the tests (see below)
  6. Commit and push
  7. Open a pull request

Development Setup

This is a Cargo workspace monorepo. All Rust crates are under crates/.

Rust Workspace

# Build everything (core + MCP server)
cargo build

# Run all tests (core + MCP)
cargo test --workspace

# Core library only
cargo test -p agentic-veritas-core

# MCP server only
cargo test -p agentic-veritas-mcp

# Run the CLI
cargo run -p agentic-veritas-cli -- intent compile "build an API"

# Run the MCP server
cargo run -p agentic-veritas-mcp -- serve

Ways to Contribute

Report Bugs

File an issue with:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • System info (OS, Rust version)

Add an MCP Tool

  1. Add the tool definition in crates/agentic-veritas-mcp/src/tools.rs
  2. Implement the handler in the handle_tool_call function
  3. Add tests
  4. Update docs/public/mcp-tools.md

Write Examples

  1. Add a new example in examples/
  2. Ensure it runs without errors
  3. Add a docstring explaining what it demonstrates

Improve Documentation

All docs are in docs/. Fix typos, add examples, clarify explanations -- all welcome.

Code Guidelines

  • Rust: Follow standard Rust conventions. Run cargo clippy and cargo fmt.
  • Tests: Every feature needs tests. We maintain 257+ tests across the stack.
  • Documentation: Update docs when changing public APIs.

Commit Messages

Use conventional commit prefixes:

  • feat: add new uncertainty scorer
  • fix: correct causal chain confidence calculation
  • docs: add integration guide
  • chore: update dependencies

Pull Request Guidelines

  • Keep PRs focused -- one feature or fix per PR
  • Include tests for new functionality
  • Update documentation if needed
  • Ensure all tests pass before submitting
  • Write a clear PR description

License

By contributing, you agree that your contributions will be licensed under the MIT License.