Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (34 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.43 KB

Contributing to AI Checkup

Thank you for your interest in contributing to AI Checkup!

How to Contribute

Reporting Bugs

  • Use the Bug Report template
  • Include steps to reproduce the issue
  • Include expected vs actual behavior

Suggesting Features

  • Use the Feature Request template
  • Describe the problem you're trying to solve

Adding a New Parser

AI Checkup supports multiple AI platforms. To add a new one:

  1. Create ai_checkup/parsers/your_platform.py extending BaseParser
  2. Implement can_parse() (auto-detection) and parse() (returns List[Conversation])
  3. Register it in ai_checkup/parsers/__init__.py
  4. Add mock data in tests/mock_data/ and tests in test_parsers.py
  5. Add auto-discover path in cli.py if the platform stores data locally

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests: pytest tests/ -v
  5. Commit your changes
  6. Push and open a Pull Request

Development Setup

git clone https://github.com/TerryFYL/ai-checkup.git
cd ai-checkup
python3 -m venv .venv && source .venv/bin/activate
pip install -e . pytest
pytest tests/ -v

License

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