Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (46 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 1.79 KB
Raw

Contributing to Amy

Thanks for your interest in contributing to Amy! This document outlines how to get started.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Install dependencies with julia --project=. -e 'using Pkg; Pkg.instantiate()'
  4. Ensure Ollama is running with DeepSeek-R1 model
  5. Run tests with julia --project=. -e 'using Pkg; Pkg.test()'

Development Workflow

# Install dependencies
julia --project=. -e 'using Pkg; Pkg.instantiate()'

# Run tests
julia --project=. -e 'using Pkg; Pkg.test()'

# Run an example
julia --project=. examples/llm_demo.jl

How to Contribute

Reporting Bugs

  • Check existing issues first to avoid duplicates
  • Use a clear, descriptive title
  • Include steps to reproduce the issue
  • Describe expected vs actual behavior

Suggesting Features

  • Open an issue describing the feature
  • Explain the use case and why it would be valuable
  • Be open to discussion about implementation approaches

Pull Requests

  1. Create a branch from main for your changes
  2. Make your changes with clear, focused commits
  3. Ensure all tests pass
  4. Open a PR with a clear description of changes
  5. Link any related issues

Code Style

  • Follow existing patterns in the codebase
  • Use meaningful variable and function names
  • Add docstrings to public functions
  • Include unit tests for new functionality

Areas for Contribution

  • Mathematical domains: Add new tool categories (plasma physics, relativity)
  • LLM improvements: Enhance agent prompts for better reasoning
  • Verification: More validation checks and physical constraints
  • Examples: New use cases and demonstrations
  • Documentation: Tutorials, examples, API documentation

Questions?

Open an issue or reach out to the maintainers. We're happy to help!