Skip to content

Contributing

We welcome contributions to OG-Learn!

Development Setup

  1. Clone the repository:
git clone https://github.com/your-username/og-learn.git
cd og-learn
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows
  1. Install in development mode:
pip install -e ".[dev]"

Code Style

  • Follow PEP 8
  • Use type hints where practical
  • Write docstrings for public functions

Running Tests

pytest tests/

Documentation

Build docs locally:

mkdocs serve

View at http://localhost:8000

Pull Requests

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests
  5. Submit a pull request

Issues

Report bugs and request features via GitHub Issues.