Skip to content

Contributing to IdeaWeaver

Thank you for your interest in contributing to IdeaWeaver! This guide will help you get started.

Getting Started

  1. Fork the Repository 

    git clone https://github.com/ideaweaver-ai-code/ideaweaver.git
cd ideaweaver

  2. Set Up Development Environment 

    ./setup_environments.sh
source ideaweaver-env/bin/activate

  3. Install Development Dependencies 

    pip install -e ".[dev]"

Development Guidelines

Code Style

  • Follow PEP 8 for Python code
  • Use type hints where possible
  • Add docstrings to all functions and classes
  • Write meaningful commit messages

Documentation

  • Update documentation for any new features
  • Test documentation locally with mkdocs serve
  • Follow the existing documentation style

Submitting Changes

  1. Create a feature branch: git checkout -b feature-name
  2. Make your changes and test thoroughly
  3. Update documentation if needed
  4. Submit a pull request with a clear description

Questions?

  • Open an issue for bug reports or feature requests
  • Join our community discussions
  • Check existing issues before creating new ones

Thank you for contributing! 🚀