Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
160 lines (119 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

160 lines (119 loc) · 3.54 KB

Contributing to HIA (Health Insights Agent) 🩺

Thank you for considering contributing to HIA! This document provides guidelines and instructions to help you get started.

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct. We aim to foster an inclusive and respectful community.

Getting Started

Prerequisites

  • Python 3.8+
  • Streamlit 1.30.0+
  • Supabase account
  • Groq API key
  • PDFPlumber
  • Python-magic-bin (Windows) or Python-magic (Linux/Mac)

Development Environment Setup

  1. Fork and clone the repository:

    git clone https://github.com/harshhh28/hia.git
cd hia

  2. Install dependencies:

    pip install -r requirements.txt

  3. Configure environment variables: Create .streamlit/secrets.toml:

    SUPABASE_URL = "your-supabase-url"
SUPABASE_KEY = "your-supabase-key"
GROQ_API_KEY = "your-groq-api-key"

  4. Set up database: Execute the SQL script in public/db/script.sql

  5. Run the application:

    streamlit run src/main.py

Development Workflow

Branching Strategy

  • main: Production-ready code
  • feature/*: New features
  • fix/*: Bug fixes
  • docs/*: Documentation updates

Git Workflow

  1. Create a branch:

    git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

  2. Make your changes

  3. Write commit messages:

    feat: Add new blood analysis component

- Implement report analysis visualization
- Add validation for blood test values
- Update documentation

  4. Push changes:

    git push origin feature/your-feature-name

  5. Create a Pull Request

Pull Request Guidelines

  • Fill out the PR template completely
  • Reference any related issues
  • Include screenshots for UI changes
  • Update documentation if needed
  • Add tests for new functionality

Coding Standards

Python Style Guide

  • Follow PEP 8
  • Use type hints for function parameters
  • Maximum line length: 88 characters
  • Use docstrings for classes and functions

Code Organization

# Imports
from typing import Optional
import streamlit as st

# Constants
MAX_UPLOAD_SIZE = 20

# Classes/Functions
class AnalysisAgent:
    """Agent for analyzing medical reports."""
    
    def __init__(self) -> None:
        """Initialize the analysis agent."""
        self.model = None

Testing Guidelines

  1. Test Coverage

    • Unit tests for utilities and services
    • Integration tests for major features
    • UI component tests

  2. Running Tests

    python -m pytest tests/

Documentation

  • Update README.md for new features
  • Add docstrings to new functions/classes
  • Include example usage where appropriate
  • Document environment variables
  • Keep API documentation current

Security

  • Never commit sensitive data
  • Follow secure coding practices
  • Validate all user inputs
  • Report security issues privately
  • Follow the Security Policy

We appreciate your contributions to making HIA better! If you have questions, feel free to open an issue or contact the maintainers.